dashhive / bls

MIT License
0 stars 0 forks source link

v1 Feedback: README #7

Closed coolaj86 closed 1 year ago

coolaj86 commented 1 year ago

Move the deep explanations to an issue or in ./docs and keep the README very clean.

Here's are a few examples:

Updates:

wmerfalen commented 1 year ago

Move the deep explanations to an issue or in ./docs and keep the README very clean.

Here's are a few examples:

* https://github.com/dashhive/dashmsg

* https://github.com/dashhive/dashmsg.js

* https://github.com/therootcompany/keypairs

Updates:

* [ ]  One line description "generates BLS keypair, based on `[Relic vX.Y](link)` and `[BLS-Signatures](link)` vX.Y"

* [ ]  Example usage & output `bls gen --json`

* [ ]  How to install via webi

* [ ]  How to install from GitHub Releases (`curl`, `chmod`, `xattr`)

* [ ]  How to build from source on Linux, something like this
  ```shell
  sudo apt install -y build-essential ...
  git clone https://github.com/dashhive/bls
  cd ./bls/
  cp example.config.ext config.ext
  sh ./install.sh
  ```

* [ ]  (maybe?) How to use the underlying library

4 Dash

coolaj86 commented 1 year ago

I also made some updates. Marked as completed.