Skip to content

Commit ca78ba5

Browse files
authored
Merge pull request #154 from iden3/feat/readme-update
Update readme
2 parents 06e6a34 + 6020d15 commit ca78ba5

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,30 @@
11
# ffjavascript
2+
23
Finite Field Library in Javascript
34

5+
This package is tested to work in the following environments:
6+
7+
- **NodeJS**
8+
- **Browser**
9+
- **Chrome Extension**
10+
- **Metamask Snaps (SES)**
11+
12+
## Knows Issues
13+
14+
### Webpack Configuration
15+
16+
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.
17+
18+
```javascript
19+
module.exports = {
20+
// ...
21+
optimization: {
22+
splitChunks: false,
23+
},
24+
// ...
25+
};
26+
```
27+
428
## License
529

630
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.
7-

0 commit comments

Comments
 (0)