Skip to content

Commit

Permalink
Merge pull request #154 from iden3/feat/readme-update
Browse files Browse the repository at this point in the history
Update readme
  • Loading branch information
Kolezhniuk authored Apr 12, 2024
2 parents 06e6a34 + 6020d15 commit ca78ba5
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,30 @@
# ffjavascript

Finite Field Library in Javascript

This package is tested to work in the following environments:

- **NodeJS**
- **Browser**
- **Chrome Extension**
- **Metamask Snaps (SES)**

## Knows Issues

### Webpack Configuration

If you're using the `ffjavascript` package in a webpack project (Next.js/Angular), you may need to disable the `splitChunks` option in your webpack configuration.

```javascript
module.exports = {
// ...
optimization: {
splitChunks: false,
},
// ...
};
```

## License

ffjavascript is part of the iden3 project copyright 2020 0KIMS association and published with GPL-3 license. Please check the COPYING file for more details.

0 comments on commit ca78ba5

Please sign in to comment.