Skip to content

Commit

Permalink
Merge pull request #257 from NationalSecurityAgency/update_readme
Browse files Browse the repository at this point in the history
updated README and project home page link
  • Loading branch information
dwalizer authored Nov 20, 2024
2 parents 0af8373 + 8da3143 commit 2d946cb
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 17 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
SkillTree is an innovative approach to implementing application training. SkillTree skills-client project is an assembly of
client libraries that facilitate rapid integration with the SkillTree service.

To learn about the SkillTree platform please visit our [Official Documentation](https://code.nsa.gov/skills-docs/).
To learn about the SkillTree platform please visit our [Official Documentation](https://skilltreeplatform.dev/).
These pages provide in-depth guidance on the installation, usage and contribution.

## Workflow Status
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -103,12 +103,5 @@ class ReleaseClientLibs {
json.dependencies.findAll { it.key.startsWith(Vars.NpmNamespace) }.each {
assert json.dependencies."${it.key}" == newVersion
}

if (npmProj.angularModule) {
File loc = new File(npmProj.loc, "projects/skilltree/skills-client-ng/")
assert loc.exists()
NpmProj angularProj = new NpmProj(loc: loc, name: loc.name, doOthersLinkToMe: true)
updateVersion(angularProj, newVersion)
}
}
}
17 changes: 9 additions & 8 deletions skills-client-js/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,6 @@ limitations under the License.
# SkillTree Client Lib - Native JS Lib

<p>
<a href="https://www.npmjs.com/package/@skilltree/skills-client-js">
<img src="https://flat.badgen.net/npm/v/@skilltree/skills-client-js" alt="Current version">
</a>
<a href="https://www.npmjs.com/package/@skilltree/skills-client-js">
<img src="https://flat.badgen.net/npm/dt/@skilltree/skills-client-js" alt="npm downloads">
</a>
Expand All @@ -33,17 +30,21 @@ limitations under the License.

SkillTree is an innovative approach to implementing application training. SkillTree's ``skills-client-js`` project facilitates rapid integration with the SkillTree service.

To learn about the SkillTree platform please visit our [Official Documentation](https://code.nsa.gov/skills-docs/).
To learn about the SkillTree platform please visit our [Official Documentation](https://skilltreeplatform.dev/).
These pages provide in-depth guidance on the installation, usage and contribution.

SkillTree client libraries offer a comprehensive set of features:
## Library Features

SkillTree client library offers 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."
- **Global event handling:** Our JS functions enable applications to register to receive 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

**Important Note:** To enable seamless integration with Skills Display, this library utilizes an iFrame wrapper to retrieve
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.

Expand All @@ -58,4 +59,4 @@ 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).
To learn how to install and use this library please visit [SkillTree's Native JS Integration Guide](https://skilltreeplatform.dev/skills-client/js.html).
2 changes: 1 addition & 1 deletion skills-client-js/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@
"User Engagement",
"Rapid Integration"
],
"homepage": "https://code.nsa.gov/skills-docs/",
"homepage": "https://skilltreeplatform.dev/",
"repository": {
"type": "git",
"url": "git+https://github.com/NationalSecurityAgency/skills-client.git"
Expand Down

0 comments on commit 2d946cb

Please sign in to comment.