snort/README.md

50 lines
1.5 KiB
Markdown
Raw Normal View History

2023-01-25 15:19:47 +00:00
## Snort
2023-01-23 11:15:29 +00:00
2023-02-13 09:02:26 +00:00
Snort is a nostr UI built with React aiming for speed and efficiency.
2023-01-23 11:15:29 +00:00
2023-01-28 21:43:56 +00:00
Snort supports the following NIP's:
2023-01-23 11:15:29 +00:00
- [x] NIP-01: Basic protocol flow description
- [x] NIP-02: Contact List and Petnames (No petname support)
- [ ] NIP-03: OpenTimestamps Attestations for Events
- [x] NIP-04: Encrypted Direct Message
- [x] NIP-05: Mapping Nostr keys to DNS-based internet identifiers
- [ ] NIP-06: Basic key derivation from mnemonic seed phrase
- [x] NIP-07: `window.nostr` capability for web browsers
2023-01-23 15:31:59 +00:00
- [x] NIP-08: Handling Mentions
2023-01-23 11:15:29 +00:00
- [x] NIP-09: Event Deletion
- [x] NIP-10: Conventions for clients' use of `e` and `p` tags in text events
2023-01-25 15:19:47 +00:00
- [x] NIP-11: Relay Information Document
2023-01-23 11:15:29 +00:00
- [x] NIP-12: Generic Tag Queries
- [ ] NIP-13: Proof of Work
- [ ] NIP-14: Subject tag in text events
- [x] NIP-15: End of Stored Events Notice
- [x] NIP-19: bech32-encoded entities
- [x] NIP-20: Command Results
2023-02-14 10:34:43 +00:00
- [x] NIP-21: `nostr:` Protocol handler (`web+nostr`)
2023-01-23 11:15:29 +00:00
- [x] NIP-25: Reactions
- [x] NIP-26: Delegated Event Signing (Display delegated signings only)
- [ ] NIP-28: Public Chat
- [ ] NIP-36: Sensitive Content
- [ ] NIP-40: Expiration Timestamp
2023-01-26 11:34:18 +00:00
- [ ] NIP-42: Authentication of clients to relays
2023-01-28 21:43:56 +00:00
- [x] NIP-50: Search
- [x] NIP-51: Lists
2023-02-10 19:23:52 +00:00
- [x] NIP-65: Relay List Metadata
2023-02-13 09:02:26 +00:00
### Running
This repository is a yarn workspace. To install dependencies, run `yarn` from the project root.
To run the application, use either
```sh
$ yarn workspace @snort/app start
```
or
```sh
$ cd packages/app
$ yarn start
```