Skip to content

Commit

Permalink
🐛 docs: update require name
Browse files Browse the repository at this point in the history
  • Loading branch information
wolfram77 committed Apr 12, 2023
1 parent 460f849 commit ac5baf0
Show file tree
Hide file tree
Showing 5 changed files with 683 additions and 3,913 deletions.
11 changes: 7 additions & 4 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ on:
tags:
- '!*' # Do not execute on tags
env:
NAME: ${{vars.NAME}}
EMAIL: ${{vars.EMAIL}}
NPM_TOKEN: ${{secrets.NPM_TOKEN}}
GITHUB_TOKEN: ${{secrets.GH_TOKEN}}
CC_TEST_REPORTER_ID: ${{secrets.CC_TEST_REPORTER_ID}}
FORCE_COLOR: 1
Expand Down Expand Up @@ -55,8 +58,7 @@ jobs:
- uses: actions/setup-node@v2
with:
node-version: 18.x
- run: git clone https://${GITHUB_TOKEN}@github.com/nodef/deploy "$HOME/deploy"
- run: bash "$HOME/deploy/setup.sh"
- uses: nodef/git-config.action@v1.0.0
- run: npm i -g typescript typedoc
- run: npm ci
- run: npm run publish-docs
Expand All @@ -71,8 +73,9 @@ jobs:
- uses: actions/setup-node@v2
with:
node-version: 18.x
- run: git clone https://${GITHUB_TOKEN}@github.com/nodef/deploy "$HOME/deploy"
- run: bash "$HOME/deploy/setup.sh"
- uses: nodef/npm-config.action@v1.0.0
with:
entries: access = public
- run: npm i -g typescript rollup typedoc browserify terser
- run: npm ci
- run: npm run publish-packages
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ Useful additions to inbuilt [path] module.<br>
📰 [Docs](https://nodef.github.io/extra-path/),
📘 [Wiki](https://github.com/nodef/extra-bit/wiki/).

This package is available in both *Node.js* and *Web* formats. The web format
is exposed as `extra_path` standalone variable and can be loaded from
[jsDelivr CDN].
This package is available in *Node.js* and *Web* formats. To use it on the web,
simply use the `extra_path` global variable after loading with a `<script>`
tag from the [jsDelivr CDN].

[path]: https://nodejs.org/api/path.html
[jsDelivr CDN]: https://cdn.jsdelivr.net/npm/extra-path.web/index.js
Expand All @@ -17,16 +17,16 @@ is exposed as `extra_path` standalone variable and can be loaded from
<br>

```javascript
const path = require('extra-path');
const xpath = require('extra-path');

function main() {
path.filename('/home/user/file+name.txt');
xpath.filename('/home/user/file+name.txt');
// → 'file+name'

path.symbolname('/home/user/file+name.txt');
xpath.symbolname('/home/user/file+name.txt');
// → 'file_name'

path.keywordname('/home/user/file+name.txt');
xpath.keywordname('/home/user/file+name.txt');
// → 'file-name'
}
main();
Expand Down

0 comments on commit ac5baf0

Please sign in to comment.