From 2c50616ab8f5bbcbe750407a396372d3b40832e7 Mon Sep 17 00:00:00 2001 From: Luke Murphy Date: Sun, 6 Oct 2019 16:19:11 +0200 Subject: [PATCH] Add example and fix links --- README.rst | 26 ++++++++++++++++++++++---- 1 file changed, 22 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index 40e1ea2..cc8c117 100644 --- a/README.rst +++ b/README.rst @@ -31,17 +31,35 @@ Cryptography primitives for Hypercore 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 ************* -* https://hypercore-crypto.readthedocs.io/ +* `hypercore-crypto.readthedocs.io`_ + +.. _hypercore-crypto.readthedocs.io: https://hypercore-crypto.readthedocs.io/ Mirroring ********* -* https://hack.decentral1.se/datpy/hypercore-crypto (primary) -* https://github.com/datpy/hypercore-crypto +* `hack.decentral1.se/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