From cc3ebfdcf9bbb222d7038db9093ff8f46e5e00bf Mon Sep 17 00:00:00 2001 From: AndriiHeonia <773648+AndriiHeonia@users.noreply.github.com> Date: Fri, 31 May 2024 07:56:30 +0200 Subject: [PATCH] update readme --- README.md | 25 ++++++------------------- package.json | 3 +-- 2 files changed, 7 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 2c8ec9a..ae5ce5c 100755 --- a/README.md +++ b/README.md @@ -50,25 +50,12 @@ You may use [polyfills](https://www.npmjs.com/package/core-js) for `Set` and com ## NPM package -This library is hosted on [GitHub Packages](https://docs.github.com/en/packages). To install it using NPM, you should have an `.npmrc` file next to your `package.json` with the following content: +This library is not hosted on npmjs.com, but you can use [GitHub URL](https://docs.npmjs.com/cli/v10/configuring-npm/package-json#github-urls) as a dependency, e.g.: ``` -@andriiheonia:registry=https://npm.pkg.github.com -//npm.pkg.github.com/:_authToken=YOUR_GITHUB_TOKEN -``` - -And include `hull` library as a dependency to your `package.json`: - -``` -"@andriiheonia/hull": "^1.0.8" -``` - -For more details see [GitHub instruction](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#installing-a-package). - -If for some reason you don't want to use GitHub Packages, you can use [GitHub URL](https://docs.npmjs.com/cli/v10/configuring-npm/package-json#github-urls) as a dependency, e.g.: - -``` -"@andriiheonia/hull": "andriiheonia/hull" +"dependencies": { + "hull.js": "andriiheonia/hull" +} ``` ## Development @@ -104,8 +91,8 @@ If you want to get involved with Hull.js development, just use