Skip to content

Commit

Permalink
Update README.md with roadmap and REFERENCES.md is added
Browse files Browse the repository at this point in the history
  • Loading branch information
Sebastix committed Jan 3, 2024
1 parent 4f60bc6 commit 3863df6
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 4 deletions.
23 changes: 19 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ $message_string = $eventMessage->generate();

## Interacting with a relay

Publish a event with a note that has been prepared for sending to a relay.
Publish an event with a note that has been prepared for sending to a relay.

```php
use swentel\nostr\Event\Event;
Expand Down Expand Up @@ -143,7 +143,7 @@ All tests can be found in `tests`.
$ php vendor/bin/phpunit
```

## nostr-php script
## nostr-php script (cli client)

The library ships with a simple CLI client (`bin/nostr-php`) to post a short text note to a Nostr relay.

Expand All @@ -155,7 +155,22 @@ $ bin/nostr-php --content "Hello world!" --key /home/path/to/nostr-private.key -
Note: the key arguments expects a file with your private key! Do not paste your
private key on command line.

## Maintainers
## Roadmap

- [x] Keypair generation and validation
- [x] Convert from hex to bech32-encoded keys
- [x] Event signing with Schnorr signatures (`secp256k1`)
- [x] Event validation
- [ ] Support NIP-01 basic protocol flow description
- [x] Publish events
- [ ] Request events
- [ ] Improve handling relay responses
- [ ] Support NIP-19 bech32-encoded identifiers
- [ ] Support NIP-42 authentication of clients to relays
- [ ] Support NIP-45 event counts
- [ ] Support NIP-50 search capability

* [@swentel](https://github.com/swentel) (original author, inactive) `npub1z8n2zt0vzkefhrhpf60face4wwq2nx87sz7wlgcvuk4adddkkycqknzjk5`
## Maintainers

* [@sebastix](https://github.com/Sebastix) `npub1qe3e5wrvnsgpggtkytxteaqfprz0rgxr8c3l34kk3a9t7e2l3acslezefe`
* [@swentel](https://github.com/swentel) (original author, inactive) `npub1z8n2zt0vzkefhrhpf60face4wwq2nx87sz7wlgcvuk4adddkkycqknzjk5`
19 changes: 19 additions & 0 deletions REFERENCES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# References

Using nostr-php:
* https://github.com/pj8912/nostrdev
* https://github.com/fabianfabian/nostr-media (a fork)

List with other helper libraries in different languages for Nostr.

* https://github.com/fiatjaf/go-nostr
* https://github.com/rust-nostr/nostr
* https://github.com/KiPSOFT/nostr-deno
* https://github.com/holgern/pynostr
* https://github.com/jeffthibault/python-nostr
* https://github.com/relaystr/dart_ndk
* https://github.com/kawax/laravel-nostr

### Used resources

* https://github.com/aljazceru/awesome-nostr?tab=readme-ov-file#libraries

0 comments on commit 3863df6

Please sign in to comment.