Kieran/snort
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
ennmichael 2023-02-13 10:02:26 +01:00
parent 2a211b78a1
commit 527bf56fad
No known key found for this signature in database
GPG Key ID: 6E6E183431A26AF7
1 changed files with 17 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
packages/app/README.md → README.md
View File

@ -1,6 +1,6 @@
## Snort
Snort is a nostr UI built with React, Snort intends to be fast and effecient
Snort is a nostr UI built with React aiming for speed and efficiency.
Snort supports the following NIP's:
@ -31,3 +31,19 @@ Snort supports the following NIP's:
- [x] NIP-50: Search
- [x] NIP-51: Lists
- [x] NIP-65: Relay List Metadata
### 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
```