summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYuval Adam <_@yuv.al>2022-01-17 19:18:44 +0200
committerYuval Adam <_@yuv.al>2022-01-17 19:18:44 +0200
commit63bd6e986cc4842e5b59d7a9224fc9d34e71e0a7 (patch)
treee40e269176eb88848ce8042dde4ad0759e952537
parentbc51ea4a71ffecd92ed81ba075e11513483778ed (diff)
Add some README
-rw-r--r--README.md15
1 files changed, 14 insertions, 1 deletions
diff --git a/README.md b/README.md
index 3460202..51a0bca 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,16 @@
# nostrpy
-A python implementation of https://github.com/fiatjaf/nostr/
+A python library and reference CLI tool implementing the [nostr](https://github.com/fiatjaf/nostr/) protocol. Still very much a work in progress.
+
+- [x] BIP-340 Schnorr signatures using the reference Python implementation
+- [ ] Complete Pythonic API for the nostr protocol
+- [ ] Reference CLI tool implementing the nostr client and server
+
+Supports Python 3.7 and up.
+
+## Dev
+
+```bash
+$ pipenv sync -d
+$ pipenv run test
+```