Skip to content

Commit

Permalink
chore(readme): update installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
rickardvh authored Jan 29, 2021
1 parent 77f89ca commit 68f1704
Showing 1 changed file with 2 additions and 9 deletions.
11 changes: 2 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,7 @@ This library contains the utility class Enumerable<T>, which implements Iterable
operating on Iterables.

# Installation
The npm package is currently published only on the GitHub package registry, which requires authentication with a personal access token (PAT) (see https://docs.github.com/en/free-pro-team@latest/packages/guides/configuring-npm-for-use-with-github-packages#authenticating-to-github-packages). To install, create a new PAT with scope read:packages under Settings/Developer settings/Personal access tokens on your GitHub profile. Next, add the following lines in your .npmrc file (create one if it does not exist) in the root of your project, replacing TOKEN with your newly created token:

```
@hogiagroup:registry=https://npm.pkg.github.com/hogiagroup
//npm.pkg.github.com/:_authToken=TOKEN
```

You can now install Enumerable with `npm install @hogiagroup/enumerable`.
Install with `npm install @hogiagroup/enumerable`.

# Getting Started
The main class is Enumerable, which can be instantiated with an existing Iterable instance or as empty. Enumerables can then be built by successively chaining methods to the original instance; Enumerable objects themselves are immutable insofar as that all methods are pure (free from side effects), but care should be taken not to modify the source iterable.
Expand All @@ -23,4 +16,4 @@ The class PivotSelectionStrategies contains predefined functions for selecting p
To build, run 'npm run build'. Tests are run with 'npm run test' or 'npm run tdd' (auto-watch).

# Contribute
Submit a pull request.
Submit a pull request.

0 comments on commit 68f1704

Please sign in to comment.