README: fixe typos, add links to the wiki elements
- commit
- 14e5ea4541e4399540a3ba16cd8d7b5fe4da96f1
- author
- bnema · · 2023-11-09 16:43 UTC
- committer
- bnema · · 2023-11-09 16:55 UTC
- parent
- 7a95807
- signature
- unsigned
1 file · +3 -5
M README.md +3 -5
| @@ -15,16 +15,14 @@ Gordon is a tool written in Go that aims to simplify the deployment of your cont | |||
| 15 | 15 | ||
| 16 | 16 | - **Ease of use**: Deploy container images effortlessly using the command **`gordon deploy`**. | |
| 17 | 17 | - **Self-Hosted**: Operates within your existing self-hosted environment and don't interfere with your setup. | |
| 18 | - | - **Self-Update**: The client can update itself to the latest version with `gordon update`. The backend is updated by pulling the latest image from ghcr.io. | |
| 19 | - | - **Web UI**: Provides a simple web UI to manage your deployments, domains, exposed ports, and more. | |
| 18 | + | - **Self-Updated**: The client can update itself to the latest version with `gordon update`. The backend is updated by pulling the latest image from ghcr.io. | |
| 19 | + | - **Minimal WebUI**: Provides a simple web UI to manage your deployments, domains, exposed ports. Using a very minimal stack (sqlite3, Go templates, HTMX and Tailwind CSS). | |
| 20 | + | - **Simple authentication**: Use Github OAuth to authenticate with the web UI and a token for the CLI. | |
| 20 | 21 | - **Automated Routing**: Collaborates with Traefik to automatically route your application to your desired domain or subdomain. | |
| 21 | 22 | - **One binary**: Gordon follows the Golang philosophy of keeping things simple, offering a single binary for all functionalities. | |
| 22 | - | - **Minimal stack**: Sqlite3 (no ORM) for the db, the web UI is built using Go templates, HTMX and Tailwind CSS | |
| 23 | - | - **Simple authentication**: Use Github OAuth to authenticate with the web UI and a token for the CLI. | |
| 24 | 23 | ||
| 25 | 24 |  | |
| 26 | 25 | ||
| 27 | - | ||
| 28 | 26 | ## **Why ?** | |
| 29 | 27 | ||
| 30 | 28 | I needed a simple tool that would automate the process of quickly spin up my web apps and preferably not on someone else's computer. And since I wanted to learn Go, I decided to build it myself. | |
| @@ -15,16 +15,14 @@ Gordon is a tool written in Go that aims to simplify the deployment of your cont | |||||
| 15 | 15 | ||||
| 16 | - **Ease of use**: Deploy container images effortlessly using the command **`gordon deploy`**. | 16 | - **Ease of use**: Deploy container images effortlessly using the command **`gordon deploy`**. | ||
| 17 | - **Self-Hosted**: Operates within your existing self-hosted environment and don't interfere with your setup. | 17 | - **Self-Hosted**: Operates within your existing self-hosted environment and don't interfere with your setup. | ||
| 18 | - | - **Self-Update**: The client can update itself to the latest version with `gordon update`. The backend is updated by pulling the latest image from ghcr.io. | 18 | + | - **Self-Updated**: The client can update itself to the latest version with `gordon update`. The backend is updated by pulling the latest image from ghcr.io. |
| 19 | - | - **Web UI**: Provides a simple web UI to manage your deployments, domains, exposed ports, and more. | 19 | + | - **Minimal WebUI**: Provides a simple web UI to manage your deployments, domains, exposed ports. Using a very minimal stack (sqlite3, Go templates, HTMX and Tailwind CSS). |
| 20 | + | - **Simple authentication**: Use Github OAuth to authenticate with the web UI and a token for the CLI. | |||
| 20 | - **Automated Routing**: Collaborates with Traefik to automatically route your application to your desired domain or subdomain. | 21 | - **Automated Routing**: Collaborates with Traefik to automatically route your application to your desired domain or subdomain. | ||
| 21 | - **One binary**: Gordon follows the Golang philosophy of keeping things simple, offering a single binary for all functionalities. | 22 | - **One binary**: Gordon follows the Golang philosophy of keeping things simple, offering a single binary for all functionalities. | ||
| 22 | - | - **Minimal stack**: Sqlite3 (no ORM) for the db, the web UI is built using Go templates, HTMX and Tailwind CSS | |||
| 23 | - | - **Simple authentication**: Use Github OAuth to authenticate with the web UI and a token for the CLI. | |||
| 24 | 23 | ||||
| 25 |  | 24 |  | ||
| 26 | 25 | ||||
| 27 | - | ||||
| 28 | ## **Why ?** | 26 | ## **Why ?** | ||
| 29 | 27 | ||||
| 30 | I needed a simple tool that would automate the process of quickly spin up my web apps and preferably not on someone else's computer. And since I wanted to learn Go, I decided to build it myself. | 28 | I needed a simple tool that would automate the process of quickly spin up my web apps and preferably not on someone else's computer. And since I wanted to learn Go, I decided to build it myself. | ||