summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorYuval Adam <_@yuv.al>2022-01-17 19:55:10 +0200
committerYuval Adam <_@yuv.al>2022-01-17 19:55:10 +0200
commita3f3c6eca2f2cc1276302b3f833b5937a91f6390 (patch)
tree759676790adbdac0bafe87bf550dad9f7a28307b /README.md
parent92c29b73665d676319048da41903e36eddb6d735 (diff)
Update README
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 9 insertions, 1 deletions
diff --git a/README.md b/README.md
index 51a0bca..0931c74 100644
--- a/README.md
+++ b/README.md
@@ -8,9 +8,17 @@ A python library and reference CLI tool implementing the [nostr](https://github.
Supports Python 3.7 and up.
+## Usage
+
+```bash
+$ pip install nostr
+```
+
## Dev
+For development it's best to use `pipenv`:
+
```bash
-$ pipenv sync -d
+$ pipenv install -d
$ pipenv run test
```