Skip to content

Commit

Permalink
fix: include shortcut links to client api reference
Browse files Browse the repository at this point in the history
  • Loading branch information
Mirasaki committed Nov 11, 2024
1 parent 15f7df3 commit 3e53a13
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 22 deletions.
18 changes: 0 additions & 18 deletions .github/workflows/publish-node.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,21 +30,3 @@ jobs:
- run: npm publish --access public
env:
NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}} # Use your npm token here

publish-gpr:
needs: [publish-npm]
runs-on: ubuntu-latest
permissions:
contents: read
packages: write
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v3
with:
node-version: '20.x'
registry-url: 'https://npm.pkg.github.com'
- run: npm install
- run: npm run build
- run: npm publish
env:
NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,8 @@ const client = new CFToolsClient({
This library provides rich comments and IntelliSense for API calls implemented in this interface, we also provide detailed guides and documentation to get you started quickly.

- For a complete example, check out [the usage guide](./documents/Usage.md).
- For the complete API reference/documentation, please check out [the docs](https://cftools.mirasaki.dev/).
- For the complete API documentation, please check out [the docs](https://cftools.mirasaki.dev/).
- For a complete overview of what the client can do, please check out the [API reference](https://cftools.mirasaki.dev/classes/classes_client.CFToolsClient.html).

## Contribution

Expand Down
2 changes: 2 additions & 0 deletions documents/Usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ const client = new CFToolsClient({
});
```

For a complete overview of what the client can do, please check out the [API reference](https://cftools.mirasaki.dev/classes/classes_client.CFToolsClient.html).

## Usage example

The following example wraps around updating a priority queue entry. This serves as an complete example on how this library and it's client are used, including error handling.
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "cftools.js",
"version": "1.0.0",
"version": "1.0.1",
"description": "JavaScript implementation for the CFTools Data API.",
"access": "public",
"main": "dist/index.js",
Expand Down

0 comments on commit 3e53a13

Please sign in to comment.