onasty: README.md (2e2e5be)

Oleksandr Smirnov docs: add docs, readme, and license (#216)..., 8 months ago

# Onasty

Full-stack application for temporary note staring with automatic deletion after being read or upon expiration.

<img src="./docs/screenshot.png" width=50% height=50%>

## Features
- 🔑 **Auth:** OAuth2 + JWT authentication.
- 📧 **Account confirmation:** Email verification for new users.
- 🔒 **Password protection:** Secure notes with a password.
- 📝 **Custom slugs:** Choose your own note URL.
- 👤 **Optional accounts:** Create an account to manage your notes, or use it anonymously.
- 🚦 **Rate limiting:** Protects API from abuse.
- ⏳ **Editable notes:** Change content or expiration time if the note hasn’t been read yet.

## 📖 Usage
1. Visit the frontend at `<your hosted url>`(there's no hosted app, yet).
2. Create a note → get a unique link.
3. Share the link — once opened, the note is gone.

## 📚 Documentation
Documentation on project and how to develop it lives [here](/docs)

1	# Onasty
2
3	Full-stack application for temporary note staring with automatic deletion after being read or upon expiration.
4
5	<img src="./docs/screenshot.png" width=50% height=50%>
6
7	## Features
8	- 🔑 Auth: OAuth2 + JWT authentication.
9	- 📧 Account confirmation: Email verification for new users.
10	- 🔒 Password protection: Secure notes with a password.
11	- 📝 Custom slugs: Choose your own note URL.
12	- 👤 Optional accounts: Create an account to manage your notes, or use it anonymously.
13	- 🚦 Rate limiting: Protects API from abuse.
14	- ⏳ Editable notes: Change content or expiration time if the note hasn’t been read yet.
15
16	## 📖 Usage
17	1. Visit the frontend at `<your hosted url>`(there's no hosted app, yet).
18	2. Create a note → get a unique link.
19	3. Share the link — once opened, the note is gone.
20
21	## 📚 Documentation
22	Documentation on project and how to develop it lives [here](/docs)