Add example and fix links
This commit is contained in:
parent
980a1e8218
commit
2c50616ab8
26
README.rst
26
README.rst
@ -31,17 +31,35 @@ Cryptography primitives for Hypercore
|
|||||||
|
|
||||||
Cryptography primitives for `Hypercore`_ (WIP).
|
Cryptography primitives for `Hypercore`_ (WIP).
|
||||||
|
|
||||||
.. _Hypercore: https://hypercore.readthedocs.io/en/latest/
|
.. _Hypercore: https://hypercore.readthedocs.io
|
||||||
|
|
||||||
|
.. _example:
|
||||||
|
|
||||||
|
Example
|
||||||
|
*******
|
||||||
|
|
||||||
|
.. code-block:: python
|
||||||
|
|
||||||
|
from hypercore_crypto import key_pair, sign, verify
|
||||||
|
|
||||||
|
public_key, secret_key = key_pair()
|
||||||
|
signature = sign(b'hello world', secret_key)
|
||||||
|
verify(message, signature, public_key)
|
||||||
|
|
||||||
.. _documentation:
|
.. _documentation:
|
||||||
|
|
||||||
Documentation
|
Documentation
|
||||||
*************
|
*************
|
||||||
|
|
||||||
* https://hypercore-crypto.readthedocs.io/
|
* `hypercore-crypto.readthedocs.io`_
|
||||||
|
|
||||||
|
.. _hypercore-crypto.readthedocs.io: https://hypercore-crypto.readthedocs.io/
|
||||||
|
|
||||||
Mirroring
|
Mirroring
|
||||||
*********
|
*********
|
||||||
|
|
||||||
* https://hack.decentral1.se/datpy/hypercore-crypto (primary)
|
* `hack.decentral1.se/datpy/hypercore-crypto`_
|
||||||
* https://github.com/datpy/hypercore-crypto
|
* `github.com/datpy/hypercore-crypto`_
|
||||||
|
|
||||||
|
.. _hack.decentral1.se/datpy/hypercore-crypto: https://hack.decentral1.se/datpy/hypercore-crypto
|
||||||
|
.. _github.com/datpy/hypercore-crypto: https://github.com/datpy/hypercore-crypto
|
||||||
|
Loading…
Reference in New Issue
Block a user