Skip to content
This repository has been archived by the owner on Aug 2, 2022. It is now read-only.

Commit

Permalink
Merge pull request #568 from thekevinbrown/patch-2
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
Cody Douglass authored Aug 12, 2019
2 parents 4a27bf1 + b82741e commit 9487f32
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,21 @@ The official distribution package can be found at [npm](https://www.npmjs.com/pa

`yarn add eosjs`

### Using with Typescript

In order to get access to the `TextEncoding` and `TextDecoding` types, you need to add `@types/text-encoding` as a dev dependency:
`yarn add --dev @types/text-encoding`

If you're using Node (not a browser) then you'll also need to make sure the `dom` lib is referenced in your `tsconfig.json`:

```
{
"compilerOptions": {
"lib": [..., "dom"]
}
}
```

### Browser Distribution

Clone this repository locally then run `yarn build-web`. The browser distribution will be located in `dist-web` and can be directly copied into your project repository. The `dist-web` folder contains minified bundles ready for production, along with source mapped versions of the library for debugging. For full browser usage examples, [see the documentation](https://eosio.github.io/eosjs/guides/1.-Browsers.html).
Expand Down

0 comments on commit 9487f32

Please sign in to comment.