Skip to content

Commit

Permalink
docs: npm token install method (#83)
Browse files Browse the repository at this point in the history
  • Loading branch information
saulmc authored Mar 14, 2022
1 parent a290f42 commit 58abd77
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,15 @@ The XMTP protocol is in the early stages of development. This pre-stable alpha l

## Installation

This library is not yet published as an NPM module. It can be installed from this repo using `npm install xmtp/xmtp-js`.
This library is not yet public on npm. It can be installed from this repo to your project directory using `npm install xmtp/xmtp-js`, or from npm using a private access token:

```bash
# In your project directory

export NPM_TOKEN=$YOUR_NPM_TOKEN
echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}" > .npmrc
npm install @xmtp/xmtp-js
```

Additional configuration is required in React environments due to the removal of polyfills from Webpack 5.

Expand Down

0 comments on commit 58abd77

Please sign in to comment.