diff --git a/LICENSE b/LICENSE index 3981436..1a9fc66 100755 --- a/LICENSE +++ b/LICENSE @@ -25,4 +25,3 @@ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - diff --git a/README.md b/README.md index 45a469f..f635f6c 100755 --- a/README.md +++ b/README.md @@ -48,6 +48,23 @@ This library relies on ES6. The ES6 features used are: You may use [polyfills](https://www.npmjs.com/package/core-js) for `Set` and compile with [babel](https://babeljs.io/) to continue to support old browsers. +## 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: + +``` +@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). + ## Development npm install # install dependencies npm test # build dist file and run tests @@ -55,7 +72,7 @@ You may use [polyfills](https://www.npmjs.com/package/core-js) for `Set` and com ## TypeScript -You can find TypeScript type definitions [here](https://www.npmjs.com/package/@types/hull.js). Keep in mind that type definitions are not maintained by the author of this library and the latest versions might not match. At the same time, this library is not actively maintained since 2015 and contains only minor changes, so even the older d.ts file should work fine. +You can find TypeScript type definitions in `src` folder. ## Contribute @@ -81,6 +98,8 @@ If you want to get involved with Hull.js development, just use