add readme

2026-03-30 21:51:48 +01:00
parent a98ef28055
commit 31d0e05dfd
4 changed files with 24 additions and 8 deletions
@@ -0,0 +1,19 @@
+# Ultrashorty
+
+Really simple HTTP redirection using a CSV file.
+
+## Usage
+
+Create a CSV file with the following headings and add in as many redirects as you like:
+
+```csv
+From,To,Status Code
+```
+
+Start Ultrashorty:
+
+```sh
+ultrashorty /path/to/redirects.csv
+```
+
+To load changes to the CSV, just stop and restart Ultrashorty.