From 84d4ee7daae98ea14541ff8860dbe08883eb2838 Mon Sep 17 00:00:00 2001 From: Marvin Wendt Date: Mon, 5 Feb 2024 10:34:32 +0100 Subject: [PATCH] docs: updated readme --- README.md | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4b86d6d..94c1ab6 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,35 @@ # GTTP CLI -GTTP is an interactive Go Text Template Parser. It allows you to write text templates, that you can interactively fill out. +GTTP is an interactive Go Text Template Parser. It allows you to write text templates, that you can interactively fill +out. ## Installation +There are multiple ways to install `gttp` on your system. + +### Install using Go + +If you have [Go](https://go.dev) installed, you can install `gttp` using the following command: + +```bash +go install github.com/gttp-cli/gttp@latest +``` + +### Install Using Web Installer + +You can install `gttp` using [instl](https://instl.sh). +Using instl is the simplest way to install `gttp` on your system. + +Just copy the following command and paste it into your terminal: + +| Operating System | Command | +|------------------|----------------------------------------------| +| macOS | curl -sSL instl.sh/gttp-cli/gttp/macos | bash| +| Windows | iwr instl.sh/gttp-cli/gttp/windows | iex| +| Linux | curl -sSL instl.sh/gttp-cli/gttp/linux | bash| + +> [!TIP] +> If you want to take a look at the script before running it, you can open the instl.sh URL in your browser. + ## Docs