diff --git a/README.md b/README.md new file mode 100644 index 0000000..3d17606 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# Paste + +A client-side paste tool that compresses text/code into shareable URLs using LZMA compression. + +## Features + +- **No server required** - All data is stored in the URL itself +- **LZMA compression** - Efficiently encodes content into URL-safe base64 +- **Syntax-friendly editor** - Line numbers, tab support, and monospace font +- **Dark/Light mode** - Toggle between themes with preference persistence +- **Copy to clipboard** - Quick copy for both content and generated URLs +- **Warning for long URLs** - Alerts when URLs may not work in all browsers + +## Usage + +1. Paste your text or code into the editor +2. Click "Generate URL" to create a shareable link +3. Share the URL - recipients can open it to view the content directly + +## How It Works + +The content is compressed using LZMA and encoded as base64 in the URL hash. When someone opens the URL, the data is decompressed client-side and displayed in the editor. No data is ever sent to a server. + +## Credits + +This project was heavily inspired by [topaz/paste](https://github.com/topaz/paste).