Skip to content

Commit

Permalink
added md files (#4)
Browse files Browse the repository at this point in the history
  • Loading branch information
TheButlah authored Oct 11, 2024
1 parent 049a4dc commit b98f6e1
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 0 deletions.
5 changes: 5 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Code of Conduct

Our code of conduct is located in the [orb-software repo][CODE_OF_CONDUCT].

[CODE_OF_CONDUCT]: https://github.com/worldcoin/orb-software/blob/main/CODE_OF_CONDUCT.md
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,15 @@ We generate blinding factors by taking as input a random seed of 32 bytes (e.g.,
## Public Generator Setup
We sample the generators for the Pedersen commitment deterministically using the Shake256 hash function which uses a public string as an initializer. This can be found under the `sample_generators` function in `./src/pedersen/mod.rs`. The public string (once used, this _must_ be fixed) can be found as the constant `PUBLIC_STRING` within `src/iriscode_commit/mod.rs`.

## Contributing

We plan to accept contributions at a later date, but do not have
bandwidth to review PRs currently.

Likewise, we are providing this source code for the benefit of the community,
but cannot commit to any SemVer or API stability guarantees. Be warned: we may
change things in a backwards-incompatible way at any time!

## License
Unless otherwise specified, all code in this repository is dual-licensed under
either:
Expand Down
6 changes: 6 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Security @ Worldcoin

For reporting security vulnerabilities and our responsible disclosure policy, please
see the [orb-software repo][orb-software].

[orb-software]: https://github.com/worldcoin/orb-software/blob/main/SECURITY.md

0 comments on commit b98f6e1

Please sign in to comment.