ci: publish to docker hub workflow

README.md

@@ -1,38 +1,95 @@
 # url-shortener
+> Lightning fast, lightweight and minimal self-hosted url shortener
 
-TODO: Write a description here
+## Self-hosted
 
-## Installation
+- Dokku
+```dockerfile
+FROM sjdonado/url-shortener
+```
+
+```bash
+dokku apps:create url-shortener
+
+dokku domains:set url-shortener bit.donado.co 
+dokku letsencrypt:enable url-shortener
+
+dokku storage:ensure-directory url-shortener-sqlite
+dokku storage:mount url-shortener /var/lib/dokku/data/storage/url-shortener-sqlite:/usr/src/app/sqlite/
+
+dokku config:set url-shortener DATABASE_URL="sqlite3://./sqlite/data.db?journal_mode=wal&synchronous=normal&foreign_keys=true" APP_URL=https://bit.donado.co
+
+dokku ports:add url-shortener http:80:4000
+dokku ports:add url-shortener https:443:4000
+
+dokku run url-shortener migrate
+dokku run url-shortener cli --create-user=Admin
+```
+
+- Run
+```bash
+docker run \
+    --name url-shortener \
+    -p 4000:4000 \
+    -e ENV="production" \
+    -e DATABASE_URL="sqlite3://./sqlite/data.db?journal_mode=wal&synchronous=normal&foreign_keys=true" \
+    -e APP_URL="http://localhost:4000" \
+    sjdonado/url-shortener
+
+docker exec -it url-shortener migrate
+docker exec -it url-shortener cli --create-user=Admin
+```
+
+## Usage
+
+**REST API**
+
+| Endpoint | HTTP Method | Description | Payload |
+|----------|-------------|-------------|---------|
+| `/api/ping` | GET | Ping the API to check if it's running | - |
+| `/:slug` | GET | Retrieve a link by its slug | - |
+| `/api/links` | GET | Retrieve all links | - |
+| `/api/links` | POST | Create a new link | `{"url": "https://example.com"}` |
+| `/api/links/:id` | PUT | Update an existing link by its ID | `{"url": "https://newexample.com"}` |
+| `/api/links/:id` | DELETE | Delete a link by its ID | - |
+
+**CLI**
+```
+Usage: ./cli [options]
+Options:
+  --create-user=NAME  Create a new user with the given name
+  --list-users        List all users
+  --delete-user=USER_ID Delete a user by ID
+```
+
+## Development
+
+**Installation**
 
 ```bash
 brew tap amberframework/micrate
 brew install micrate
-
-shards install
 ```
 
-TODO: Write installation instructions here
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
 ```bash
-DATABASE_URL=sqlite3://./sqlite/data.db micrate up
+shards run migrate
 shards run url-shortener
 ```
 
-## Build
+**Generate an API_KEY**
 
 ```bash
-shards build
+shards run cli -- --create-user=Admin
+```
+
+## Run tests
+```bash
+ENV=test crystal spec
 ```
 
 ## Contributing
 
-1. Fork it (<https://github.com/your-github-user/url-shortener/fork>)
+1. Fork it (<https://github.com/sjdonado/url-shortener/fork>)
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
@@ -40,4 +97,4 @@ shards build
 
 ## Contributors
 
-- [Juan Rodriguez](https://github.com/your-github-user) - creator and maintainer
+- [sjdonado](https://github.com/sjdonado) - creator and maintainer