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 cd5f846 commit ed257f7
Show file tree
Hide file tree
Showing 5 changed files with 694 additions and 3,918 deletions.
11 changes: 7 additions & 4 deletions .github/workflows/ci.yml
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
30 changes: 15 additions & 15 deletions README.md
@@ -1,24 +1,24 @@
A collection of functions for working with BigInts.<br>
A [BigInt] can represent whole numbers larger than 2⁵³ - 1 [(1)].<br>
📦 [Node.js](https://www.npmjs.com/package/extra-bigint),
🌐 [Web](https://www.npmjs.com/package/extra-bigint.web),
📜 [Files](https://unpkg.com/extra-bigint/),
📰 [Docs](https://nodef.github.io/extra-bigint/),
📘 [Wiki](https://github.com/nodef/extra-bigint/wiki/).

A [BigInt] can represent whole numbers larger than 2⁵³ - 1 [(1)]. *ES2020*
introduced it as a built-in object. `BigInt` enables us to represent integers
with arbitrary precision, allowing us to perform mathematical operations on
large integers [(2)]. This package includes common bigint functions related to
querying **about** numbers, **comparing** numbers, performing **rounded
division**, performing **modulo** operations, **controlling range** of numbers,
performing **arithmetic** operations, obtaining **divisors** of a number (and
related operations), getting the number of possible **arrangements** of a set of
objects, performing **geometry**-related calculations, performing basic
**statistical** analysis, and finding various **statistical means**.

This package is available in *Node.js* and *Web* formats. The web format
is exposed as `extra_bigint` standalone variable and can be loaded from
[jsDelivr CDN].
*ES2020* introduced **BigInt** as a built-in object. **BigInt** enables us to
represent integers with arbitrary precision, allowing us to perform mathematical
operations on large integers [(2)]. This package includes common bigint
functions related to querying **about** numbers, **comparing** numbers,
performing **rounded division**, performing **modulo** operations, **controlling**
**range** of numbers, performing **arithmetic** operations, obtaining **divisors**
of a number (and related operations), getting the number of possible
**arrangements** of a set of objects, performing **geometry**-related
calculations, performing basic **statistical** analysis, and finding various
**statistical means**.

This package is available in *Node.js* and *Web* formats. To use it on the web,
simply use the `extra_bigint` global variable after loading with a `<script>`
tag from the [jsDelivr CDN].

> Stability: [Experimental](https://www.youtube.com/watch?v=L1j93RnIxEo).
Expand Down

0 comments on commit ed257f7

Please sign in to comment.