Skip to content

Commit

Permalink
docs: updated README.md with same warning as in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
gbotrel authored Mar 22, 2022
1 parent 859f150 commit 6eac5f9
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,28 +17,33 @@ src="logo_new.png">
* [`gnark` Issues]
* [`gnark` Benchmarks](https://docs.gnark.consensys.net/en/latest/#gnark-is-fast)

## Issues

`gnark` issues are tracked [in the GitHub issues tab][`gnark` Issues].
## `gnark` Users

If you have any questions, queries or comments, [GitHub discussions] is the place to find us.
To get started with `gnark` and write your first circuit, follow [these instructions][`gnark` User Documentation].

You can also get in touch directly: [email protected]
Checkout the [online playground][`gnark` Playground] to compile circuits and visualize constraint systems.


## `gnark` Users
## Warning
**`gnark` has not been audited and is provided as-is, we make no guarantees or warranties to its safety and reliability. In particular, `gnark` makes no security guarantees such as constant time implementation or side-channel attack resistance.**

`gnark` and `gnark-crypto` packages are optimized for 64bits architectures (x86 `amd64`) and tested on Unix (Linux / macOS).

To get started with `gnark` and write your first circuit, follow [these instructions][`gnark` User Documentation].

Checkout the [online playground][`gnark` Playground] to compile circuits and visualize constraint systems.
## Issues

`gnark` issues are tracked [in the GitHub issues tab][`gnark` Issues].

If you have any questions, queries or comments, [GitHub discussions] is the place to find us.

You can also get in touch directly: [email protected]


## Release Notes

[Release Notes](CHANGELOG.md)


## Proving schemes and curves

Refer to [Proving schemes and curves] for more details.
Expand Down

0 comments on commit 6eac5f9

Please sign in to comment.