Skip to content

Commit b7a5e52

Browse files
committed
Reword features list
1 parent daed220 commit b7a5e52

File tree

1 file changed

+16
-10
lines changed

1 file changed

+16
-10
lines changed

README.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,20 @@ A minimal pastebin with a design shamelessly copied from
1212

1313
## Features
1414

15-
* axum and sqlite3 backend storing compressed paste data
16-
* single binary with low memory footprint
17-
* drag 'n' drop upload
18-
* deletion after expiration, reading or by owners
19-
* light/dark mode according to browser settings
20-
* highlightable line numbers
21-
* QR code to browse a paste's URL on mobile devices
22-
* optional encryption with argon2 hashing and ChaCha20Poly1305 encryption
15+
* [axum](https://github.com/tokio-rs/axum) and [sqlite3](https://www.sqlite.org) backend
16+
* comes as a single binary with low memory footprint
17+
* provides paste compression using [zstd](https://github.com/facebook/zstd)
18+
* highlights entries with [syntect](https://github.com/trishume/syntect)
19+
* has seven color themes in light and dark mode
20+
* encrypts entries using ChaCha20Poly1305 and argon2 hashed passwords
21+
* allows deletion after expiration, after reading or by anonymous owners
22+
* shows QR code to browse a paste's URL on mobile devices
23+
24+
### Non-features
25+
26+
* user authentication and admin functionality
27+
* arbitrary file uploads
28+
* mitigations for all kinds of DoS attack vectors
2329

2430

2531
## Installation
@@ -145,9 +151,9 @@ run-time behavior:
145151
| `WASTEBIN_MAX_PASTE_EXPIRATION` | Maximum allowed lifetime of a paste in seconds. Disable with 0. | `0` |
146152
| `WASTEBIN_PASSWORD_SALT` | Salt used to hash user passwords used for encrypting pastes. | `somesalt` |
147153
| `WASTEBIN_SIGNING_KEY` | Key to sign cookies. Must be at least 64 bytes long. | Random key generated at startup, i.e. cookies will become invalid after restarts and paste creators will not be able to delete their pastes. |
148-
| `WASTEBIN_THEME` | Theme colors and one of `ayu`, `base16ocean`, `coldark`, `gruvbox`, `monokai`, `onehalf`, `solarized`. | `ayu` |
154+
| `WASTEBIN_THEME` | Theme colors, one of `ayu`, `base16ocean`, `coldark`, `gruvbox`, `monokai`, `onehalf`, `solarized`. | `ayu` |
149155
| `WASTEBIN_TITLE` | HTML page title. | `wastebin` |
150-
| `RUST_LOG` | Log level. Besides the typical `trace`, `debug`, `info` etc. keys, you can also set the `tower_http` key to a log level to get additional request and response logs. | --- |
156+
| `RUST_LOG` | Log level. Besides the typical `trace`, `debug`, `info` etc. keys, you can also set the `tower_http` key to a log level to get additional request and response logs. | |
151157

152158

153159
### API endpoints

0 commit comments

Comments
 (0)