Skip to content

Readme update: pushed 'installation' to the top #92

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pj8912 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Readme update: pushed 'installation' to the top #92

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
# python-nostr
A Python library for making [Nostr](https://github.com/nostr-protocol/nostr) clients


## Installation
```bash
pip install nostr
```

Note: I wrote this with Python 3.9.5.

## Usage
**Generate a key**
```python
Expand Down Expand Up @@ -159,13 +167,6 @@ The resulting delegation tag can be stored as plaintext and reused as-is by the
Hopefully clients will include an optional field to store the delegation tag. That would allow the "delegatee" PK to seamlessly post messages on the "identity" key's behalf, while the "identity" key stays safely offline in cold storage.


## Installation
```bash
pip install nostr
```

Note: I wrote this with Python 3.9.5.

## Test Suite
See the [Test Suite README](test/README.md)

Expand Down