chore: change readme
This commit is contained in:
parent
c3853066be
commit
cecd8ba586
GPG Key ID:
DE71CEB3925BE941
94
README.md
94
README.md
@ -1,70 +1,28 @@
|
|||||||
# Getting Started with Create React App
|
## Snort
|
||||||
|
|
||||||
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
|
Snort is a nostr UI built with React, Snort intends to be fast and effecient
|
||||||
|
|
||||||
## Available Scripts
|
Snort supports the following NIP's
|
||||||
|
- [x] NIP-01: Basic protocol flow description
|
||||||
In the project directory, you can run:
|
- [x] NIP-02: Contact List and Petnames (No petname support)
|
||||||
|
- [ ] NIP-03: OpenTimestamps Attestations for Events
|
||||||
### `yarn start`
|
- [x] NIP-04: Encrypted Direct Message
|
||||||
|
- [x] NIP-05: Mapping Nostr keys to DNS-based internet identifiers
|
||||||
Runs the app in the development mode.\
|
- [ ] NIP-06: Basic key derivation from mnemonic seed phrase
|
||||||
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
|
- [x] NIP-07: `window.nostr` capability for web browsers
|
||||||
|
- [ ] NIP-08: Handling Mentions
|
||||||
The page will reload when you make changes.\
|
- [x] NIP-09: Event Deletion
|
||||||
You may also see any lint errors in the console.
|
- [x] NIP-10: Conventions for clients' use of `e` and `p` tags in text events
|
||||||
|
- [ ] NIP-11: Relay Information Document
|
||||||
### `yarn test`
|
- [x] NIP-12: Generic Tag Queries
|
||||||
|
- [ ] NIP-13: Proof of Work
|
||||||
Launches the test runner in the interactive watch mode.\
|
- [ ] NIP-14: Subject tag in text events
|
||||||
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
|
- [x] NIP-15: End of Stored Events Notice
|
||||||
|
- [x] NIP-19: bech32-encoded entities
|
||||||
### `yarn build`
|
- [x] NIP-20: Command Results
|
||||||
|
- [x] NIP-25: Reactions
|
||||||
Builds the app for production to the `build` folder.\
|
- [x] NIP-26: Delegated Event Signing (Display delegated signings only)
|
||||||
It correctly bundles React in production mode and optimizes the build for the best performance.
|
- [ ] NIP-28: Public Chat
|
||||||
|
- [ ] NIP-36: Sensitive Content
|
||||||
The build is minified and the filenames include the hashes.\
|
- [ ] NIP-40: Expiration Timestamp
|
||||||
Your app is ready to be deployed!
|
- [ ] NIP-42: Authentication of clients to relays
|
||||||
|
|
||||||
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
|
|
||||||
|
|
||||||
### `yarn eject`
|
|
||||||
|
|
||||||
**Note: this is a one-way operation. Once you `eject`, you can't go back!**
|
|
||||||
|
|
||||||
If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
|
|
||||||
|
|
||||||
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.
|
|
||||||
|
|
||||||
You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.
|
|
||||||
|
|
||||||
## Learn More
|
|
||||||
|
|
||||||
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
|
|
||||||
|
|
||||||
To learn React, check out the [React documentation](https://reactjs.org/).
|
|
||||||
|
|
||||||
### Code Splitting
|
|
||||||
|
|
||||||
This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
|
|
||||||
|
|
||||||
### Analyzing the Bundle Size
|
|
||||||
|
|
||||||
This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
|
|
||||||
|
|
||||||
### Making a Progressive Web App
|
|
||||||
|
|
||||||
This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
|
|
||||||
|
|
||||||
### Advanced Configuration
|
|
||||||
|
|
||||||
This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
|
|
||||||
|
|
||||||
### Deployment
|
|
||||||
|
|
||||||
This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
|
|
||||||
|
|
||||||
### `yarn build` fails to minify
|
|
||||||
|
|
||||||
This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
|
|
||||||
Loading…
Reference in New Issue
Block a user