-
Notifications
You must be signed in to change notification settings - Fork 57
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #154 from iden3/feat/readme-update
Update readme
- Loading branch information
Showing
1 changed file
with
24 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|