Skip to content
This repository was archived by the owner on Feb 8, 2025. It is now read-only.

Commit cc3ebfd

Browse files
committed
update readme
1 parent 430461f commit cc3ebfd

File tree

2 files changed

+7
-21
lines changed

2 files changed

+7
-21
lines changed

README.md

Lines changed: 6 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -50,25 +50,12 @@ You may use [polyfills](https://www.npmjs.com/package/core-js) for `Set` and com
5050

5151
## NPM package
5252

53-
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:
53+
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.:
5454

5555
```
56-
@andriiheonia:registry=https://npm.pkg.github.com
57-
//npm.pkg.github.com/:_authToken=YOUR_GITHUB_TOKEN
58-
```
59-
60-
And include `hull` library as a dependency to your `package.json`:
61-
62-
```
63-
"@andriiheonia/hull": "^1.0.8"
64-
```
65-
66-
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).
67-
68-
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.:
69-
70-
```
71-
"@andriiheonia/hull": "andriiheonia/hull"
56+
"dependencies": {
57+
"hull.js": "andriiheonia/hull"
58+
}
7259
```
7360

7461
## Development
@@ -104,8 +91,8 @@ If you want to get involved with Hull.js development, just use <a href="https://
10491
<details>
10592
<summary>Expand</summary>
10693

107-
### 1.0.8 - 09.05.2024
108-
- Migrate from [npmjs registry](https://docs.npmjs.com/cli/v10/using-npm/registry) to [GitHub Packages](https://docs.github.com/en/packages).
94+
### 1.0.8 - 31.05.2024
95+
- Deprecate library on [npmjs registry](https://docs.npmjs.com/cli/v10/using-npm/registry).
10996
### 1.0.7 - 03.05.2024
11097
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:
11198
- Fix issue with formatting when users pass less than 4 points as an input.

package.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
11
{
2-
"name": "@andriiheonia/hull",
2+
"name": "hull.js",
33
"version": "1.0.8",
44
"description": "JavaScript library that builds concave hulls (shapes) by the set of points",
55
"homepage": "https://github.com/AndriiHeonia/hull",
66
"keywords": [
77
"geometry",
88
"concave-hull",
99
"math",
10-
"alpha-shape",
1110
"algorithm"
1211
],
1312
"author": "Andrii Heonia",

0 commit comments

Comments
 (0)