From 155d4f2954ea226385b94cb0401fb8a57698f7a8 Mon Sep 17 00:00:00 2001 From: Subhajit Sahu Date: Mon, 10 Apr 2023 01:43:20 +0530 Subject: [PATCH] :bug: docs: update require name, description --- .github/workflows/ci.yml | 11 +- README.md | 29 +- package-lock.json | 1521 ++++++++++++++++++++------------------ package.json | 16 +- src/index.ts | 2 +- tests/index.test.ts | 7 +- wiki | 2 +- 7 files changed, 819 insertions(+), 769 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 8a878aa..244db5c 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -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 @@ -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 @@ -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 diff --git a/README.md b/README.md index 596f92b..3fefa5a 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,24 @@ -Common operations for 32-bit integers.
+A [32-bit integer] can store values from `-2^31` to `2^31 - 1`.
📦 [Node.js](https://www.npmjs.com/package/extra-integer), 🌐 [Web](https://www.npmjs.com/package/extra-integer.web), 📜 [Files](https://unpkg.com/extra-integer/), 📰 [Docs](https://nodef.github.io/extra-integer/), 📘 [Wiki](https://github.com/nodef/extra-integer/wiki/). -A [32-bit integer] can store values from −2^31 ([MIN_VALUE]) to 2^31 − 1 +This package deals with the manipulation of **32-bit integers** in JavaScript, +which can store values ranging from `-2^31` ([MIN_VALUE]) to `2^31 - 1` ([MAX_VALUE]). JavaScript converts a `Number` (a *64-bit floating point number*) -to a *32-bit* *integer* (`int32`) when bitwise operators (such as `|`) are -applied. Use [is] to check is a number can be represented as a *32-bit integer*. +to a *32-bit integer* (`int32`) when bitwise operators (such as `|`) are +applied. + +Use [is] to check is a number can be represented as a *32-bit integer*. **Sign**-based operations include [abs] and [signEqual]. **Power/logarithm** related operations include [isPow2], [prevPow2], [nextPow2], [pow2], [pow10], [log2], and [log10]. -This package is available in *Node.js* and *Web* formats. The web format -is exposed as `extra_integer` 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_integer` global variable after loading with a `