README: fixe typos, add links to the wiki elements
- commit
- 8c8cbe4f8b0152d02c9b4b1f721f17eda3da833a
- author
- bnema · · 2023-11-09 16:43 UTC
- parent
- 597b228
- signature
- unsigned
1 file · +7 -2
M README.md +7 -2
| @@ -14,7 +14,8 @@ Gordon is a tool written in Go that aims to simplify the deployment of your cont | |||
| 14 | 14 | ## **Key Features** | |
| 15 | 15 | ||
| 16 | 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 existing 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 | 19 | - **Web UI**: Provides a simple web UI to manage your deployments, domains, exposed ports, and more. | |
| 19 | 20 | - **Automated Routing**: Collaborates with Traefik to automatically route your application to your desired domain or subdomain. | |
| 20 | 21 | - **One binary**: Gordon follows the Golang philosophy of keeping things simple, offering a single binary for all functionalities. | |
| @@ -30,7 +31,11 @@ I needed a simple tool that would automate the process of quickly spin up my web | |||
| 30 | 31 | ||
| 31 | 32 | ## **Installation / Getting Started / Usage** | |
| 32 | 33 | ||
| 33 | - | For detailed instructions, please refer to the wiki: <https://github.com/bnema/gordon/wiki/> | |
| 34 | + | For detailed instructions, please refer to the [wiki](https://github.com/bnema/gordon/wiki/) | |
| 35 | + | ||
| 36 | + | - [Setting up Gordon’s Backend](https://github.com/bnema/gordon/wiki/Setting-up-Gordon%E2%80%99s-Backend) | |
| 37 | + | - [Setting up Gordon's Client](https://github.com/bnema/gordon/wiki/Setting-up-Gordon's-Client) | |
| 38 | + | - [Deploying your first app](https://github.com/bnema/gordon/wiki/First-deployment) | |
| 34 | 39 | ||
| 35 | 40 | ||
| 36 | 41 | ## **Development Status & Disclaimer** | |
| @@ -14,7 +14,8 @@ Gordon is a tool written in Go that aims to simplify the deployment of your cont | |||||
| 14 | ## **Key Features** | 14 | ## **Key Features** | ||
| 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 existing 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 | - **Web UI**: Provides a simple web UI to manage your deployments, domains, exposed ports, and more. | 19 | - **Web UI**: Provides a simple web UI to manage your deployments, domains, exposed ports, and more. | ||
| 19 | - **Automated Routing**: Collaborates with Traefik to automatically route your application to your desired domain or subdomain. | 20 | - **Automated Routing**: Collaborates with Traefik to automatically route your application to your desired domain or subdomain. | ||
| 20 | - **One binary**: Gordon follows the Golang philosophy of keeping things simple, offering a single binary for all functionalities. | 21 | - **One binary**: Gordon follows the Golang philosophy of keeping things simple, offering a single binary for all functionalities. | ||
| @@ -30,7 +31,11 @@ I needed a simple tool that would automate the process of quickly spin up my web | |||||
| 30 | 31 | ||||
| 31 | ## **Installation / Getting Started / Usage** | 32 | ## **Installation / Getting Started / Usage** | ||
| 32 | 33 | ||||
| 33 | - | For detailed instructions, please refer to the wiki: <https://github.com/bnema/gordon/wiki/> | 34 | + | For detailed instructions, please refer to the [wiki](https://github.com/bnema/gordon/wiki/) |
| 35 | + | ||||
| 36 | + | - [Setting up Gordon’s Backend](https://github.com/bnema/gordon/wiki/Setting-up-Gordon%E2%80%99s-Backend) | |||
| 37 | + | - [Setting up Gordon's Client](https://github.com/bnema/gordon/wiki/Setting-up-Gordon's-Client) | |||
| 38 | + | - [Deploying your first app](https://github.com/bnema/gordon/wiki/First-deployment) | |||
| 34 | 39 | ||||
| 35 | 40 | ||||
| 36 | ## **Development Status & Disclaimer** | 41 | ## **Development Status & Disclaimer** | ||