Skip to content

Commit 81d4ebe

Browse files
committed
🐛 docs: update require name
1 parent 5102f8f commit 81d4ebe

File tree

5 files changed

+119
-90
lines changed

5 files changed

+119
-90
lines changed

.github/workflows/ci.yml

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ on:
77
tags:
88
- '!*' # Do not execute on tags
99
env:
10+
NAME: ${{vars.NAME}}
11+
EMAIL: ${{vars.EMAIL}}
12+
NPM_TOKEN: ${{secrets.NPM_TOKEN}}
1013
GITHUB_TOKEN: ${{secrets.GH_TOKEN}}
1114
CC_TEST_REPORTER_ID: ${{secrets.CC_TEST_REPORTER_ID}}
1215
FORCE_COLOR: 1
@@ -55,8 +58,7 @@ jobs:
5558
- uses: actions/setup-node@v2
5659
with:
5760
node-version: 18.x
58-
- run: git clone https://${GITHUB_TOKEN}@github.com/nodef/deploy "$HOME/deploy"
59-
- run: bash "$HOME/deploy/setup.sh"
61+
- uses: nodef/git-config.action@v1.0.0
6062
- run: npm i -g typescript typedoc
6163
- run: npm ci
6264
- run: npm run publish-docs
@@ -71,8 +73,9 @@ jobs:
7173
- uses: actions/setup-node@v2
7274
with:
7375
node-version: 18.x
74-
- run: git clone https://${GITHUB_TOKEN}@github.com/nodef/deploy "$HOME/deploy"
75-
- run: bash "$HOME/deploy/setup.sh"
76+
- uses: nodef/npm-config.action@v1.0.0
77+
with:
78+
entries: access = public
7679
- run: npm i -g typescript rollup typedoc browserify terser
7780
- run: npm ci
7881
- run: npm run publish-packages

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ Utilities for processing JavaScript text.<br>
44
📜 [Files](https://unpkg.com/extra-javascript-text/),
55
📰 [Docs](https://nodef.github.io/extra-javascript-text/).
66

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

1111
> Stability: [Experimental](https://www.youtube.com/watch?v=L1j93RnIxEo).
1212
@@ -15,17 +15,17 @@ is exposed as `extra_javascript_text` standalone variable and can be loaded from
1515
<br>
1616

1717
```javascript
18-
const fs = require('fs');
19-
const javascript = require('extra-javascript-text');
18+
const fs = require('fs');
19+
const xjavascript = require('extra-javascript-text');
2020

2121

2222
function main() {
2323
var txt = fs.readFileSync('src/index.ts', 'utf8').replace(/\r?\n/, '\n');
2424

25-
javascript.importSymbols(txt);
25+
xjavascript.importSymbols(txt);
2626
// []
2727

28-
javascript.exportSymbols(txt);
28+
xjavascript.exportSymbols(txt);
2929
// [
3030
// {
3131
// full: 'export function tagStrings',
@@ -42,7 +42,7 @@ function main() {
4242
// ...
4343
// ]
4444

45-
javascript.jsdocSymbols(txt);
45+
xjavascript.jsdocSymbols(txt);
4646
// [
4747
// {
4848
// full: '/**\r\n' +

package-lock.json

Lines changed: 95 additions & 72 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)