1 files changed, 47 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1090e77
--- /dev/null
+++ b/README.md
@@ -0,0 +1,47 @@
+# kj-clipboard
+
+no frills, just a public clipboard on the internet that you can use to share snippets around. that's it.
+
+## features
+
+- paste text, get a shareable link
+- syntax highlighting (highlight.js) with language selection
+- password-protect pastes with [mojicrypt](https://github.com/kj-sh604/mojicrypt) (emojified aes-256-gcm)
+- copy to clipboard
+- raw paste view (for snippets with no encryption)
+- sqlite 🐐
+- single-file python server, no frameworks, no bloat
+
+## dependencies
+
+- python 3.12+
+- [mojicrypt](https://github.com/kj-sh604/mojicrypt) (optional — only needed for encrypted pastes)
+
+## run
+
+```sh
+python3 server.py
+```
+
+listens on `0.0.0.0:5555` by default. configure with environment variables:
+
+```sh
+KJ_CLIPBOARD_PORT=8080 KJ_CLIPBOARD_BIND=127.0.0.1 python3 server.py
+```
+
+## docker
+
+```sh
+docker build -t kj-clipboard .
+docker run -p 5555:5555 -v kj-clipboard-data:/app/data kj-clipboard
+```
+
+## screenshot
+
+it looks exactly how you'd expect — a textarea and a button.
+
+TODO: add screenshot
+
+## license
+
+MIT
+\ No newline at end of file