doc(readme): add readme (#7)

vit0rr · Oct 18, 2024 · 9d23745 · 9d23745
1 parent 84c8665
commit 9d23745
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,36 @@
+## Short Spot
+
+Short Spot is a URL shortening service that allows users to shorten long URLs into short, easy-to-remember links.
+
+## Features
+
+#### Backend
+- Shorten long URLs into short links:
+  ![Shorten URL](./imgs/short-url.png)
+- Redirect short links to the original URLs:
+  ![Redirect URL](./imgs/redirect-url.png)
+
+#### Frontend
+WIP
+
+## How to run
+```bash
+git clone [email protected]:vit0rr/short-spot.git
+```
+
+```bash
+cd short-spot
+```
+
+```bash
+go mod tidy
+```
+
+```bash
+docker compose up
+```
+
+```bash
+go run cmd/api/main.go 
+# or configure your GoPath and run
+```
diff --git a/imgs/redirect-url.png b/imgs/redirect-url.png
diff --git a/imgs/short-url.png b/imgs/short-url.png