Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
AndriiHeonia committed May 31, 2024
1 parent 430461f commit cc3ebfd
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 21 deletions.
25 changes: 6 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -104,8 +91,8 @@ If you want to get involved with Hull.js development, just use <a href="https://
<details>
<summary>Expand</summary>

### 1.0.8 - 09.05.2024
- Migrate from [npmjs registry](https://docs.npmjs.com/cli/v10/using-npm/registry) to [GitHub Packages](https://docs.github.com/en/packages).
### 1.0.8 - 31.05.2024
- Deprecate library on [npmjs registry](https://docs.npmjs.com/cli/v10/using-npm/registry).
### 1.0.7 - 03.05.2024
This release squashes former 1.0.3, 1.0.4, 1.0.5 and 1.0.6 releases into one reasonable commit with the following minor changes:
- Fix issue with formatting when users pass less than 4 points as an input.
Expand Down
3 changes: 1 addition & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
{
"name": "@andriiheonia/hull",
"name": "hull.js",
"version": "1.0.8",
"description": "JavaScript library that builds concave hulls (shapes) by the set of points",
"homepage": "https://github.com/AndriiHeonia/hull",
"keywords": [
"geometry",
"concave-hull",
"math",
"alpha-shape",
"algorithm"
],
"author": "Andrii Heonia",
Expand Down

0 comments on commit cc3ebfd

Please sign in to comment.