From 63bd6e986cc4842e5b59d7a9224fc9d34e71e0a7 Mon Sep 17 00:00:00 2001 From: Yuval Adam <_@yuv.al> Date: Mon, 17 Jan 2022 19:18:44 +0200 Subject: Add some README --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) 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 +``` -- cgit v1.3.1