Preparing for open sourcing

[zhenfeizhang]

Here are a list of todos; ESSENTIAL are the ones that need to be solved before we open up this repo:

• logistics
  • [ESSENTIAL] choose a proper license: MIT
  • [ESSENTIAL] proper reading/writing permissions
  • create a channel for the community: telegram, discord, others? do it after open sourcing
  • create a PR template
• documentation
  • [ESSENTIAL] update read me
  • update cargo doc
• code
  • [ESSENTIAL] conduct one more code review and remove sensitive info
  • [ESSENTIAL] update other libraries to make sure nothing breaks
  • [ESSENTIAL] add Plonk benchmark
  • [ESSENTIAL] open source tagged-base64 repo
  • check testing coverage
  • update to latest dependencies expose apis under testing #12
  • check benchmark scripts
  • expose test API via feature test expose apis under testing #12
• badges (low priority)
  • license
  • CI
  • crates.io (after code is published at crates.io)
  • test coverage <- require a dedicated CI service

[chancharles92]

Should "update README" also be a "ESSENTIAL"? There are some paragraphs related to transaction generation/verification that need to be deleted.

[alxiong]

• auto enable direnv via .envrc, so that community can easily enter our nix-shell when cd into the directory with all dep installed and ready to run (add instruction to run direnv allow inside "Getting Started")
• remove cargo husky and use nix's pre-commit hooks

@sveitser Can you help us submit a PR for ☝️ ?

[alxiong]

@chancharles92 I think we should also highlight some advanced feature we had including proving key merging and batched proving in the README (with benchmark?) as well?