Skip to content

Commit

Permalink
#251: improved readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sudo-may committed Oct 9, 2024
1 parent 6851ef1 commit f6fdded
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions skills-client-js/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,26 @@ SkillTree is an innovative approach to implementing application training. SkillT
To learn about the SkillTree platform please visit our [Official Documentation](https://code.nsa.gov/skills-docs/).
These pages provide in-depth guidance on the installation, usage and contribution.

SkillTree client libraries offer a comprehensive set of features:

- **Seamless navigation and visualization:** Our Skill Display component provides a fully navigable Ranking and Visualization view, making it easy for users to explore and understand their skills.
- **Effortless skill event reporting:** The SkillsReporter JS utility simplifies the process of reporting skill events, ensuring accurate and timely tracking of user progress.
- **Convenient level display:** Our level display component provides a straightforward way to showcase a user's current overall level within the application.
- **Global event handling:** Our JS functions enable applications to register for all skill events, allowing for real-time notifications and updates. For example, you can use this feature to display encouraging messages when users earn points or complete levels, further enhancing their engagement and motivation."

**Important Note:** To enable seamless integration with Skills Display, this library utilizes an iFrame wrapper to retrieve
the necessary views and data from the skills-service application. This deliberate architectural design choice is a key
aspect of the SkillTree Platform, as it minimizes the need for frequent upgrades to the skills-client library.

By decoupling the Skills Display functionality from the skills-client library, we've achieved a significant advantage:
most updates and improvements to Skills Display will be automatically reflected in the skills-client library whenever
the skills-service application is upgraded. This means that skills-client integrators can enjoy the benefits of new
features and enhancements without the need for manual library updates.

As a result, **the skills-client libraries are intentionally designed to be relatively static, with infrequent releases**.
This approach ensures that integrators can rely on a stable and consistent library, while still benefiting from the
ongoing evolution of the SkillTree Platform.

## Installation and Usage

To learn how to install and use this library please visit [SkillTree's Native JS Integration Guide](https://code.nsa.gov/skills-docs/skills-client/js.html).

0 comments on commit f6fdded

Please sign in to comment.