Initial setup

README.md

@@ -0,0 +1,26 @@
+# Pastable
+
+Pastable is a free and open-source Plabble initiative to Pastebin.
+
+## Features
+- Paste text and code
+    - Optional expiration
+    - Self destruct option (view N times)
+- URL shortener
+- One-time password share
+
+## Routes
+
+- GET `/` - Home page with explanation
+- GET `/:id` -  based on Accept header, syntax-highlighted HTML or plain text
+- POST `/` - create a new paste (default no expiration and infinite views), plain text raw body.
+OR: form parameters `content`, and optional `language`, `expires` (UNIX timestamp) and `max_views` (integer)
+Returns generated id as plain text.
+- POST `/:id` - same as POST `/`, but uses the ID if available. Else it returns a random id.
+- POST `/once` - same as POST `/`, but sets `max_views` to 1
+- POST `/once/:id` - same as POST `/:id`, but sets `max_views` to 1
+- GET `/to/:id` - navigate to shortcut link (redirects using HTTP if found)
+- POST `/to` - create a new link (plain text raw body)
+OR: form parameter `href`.
+Returns generated id as plain text.
+- POST `/to/:id` - same but uses the ID if available, else it returns a random id.