Skip to content

Commit

Permalink
docs: updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
MarvinJWendt committed Feb 5, 2024
1 parent 246bb30 commit 84d4ee7
Showing 1 changed file with 28 additions and 1 deletion.
29 changes: 28 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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 | <code>curl -sSL instl.sh/gttp-cli/gttp/macos | bash</code>|
| Windows | <code>iwr instl.sh/gttp-cli/gttp/windows | iex</code>|
| Linux | <code>curl -sSL instl.sh/gttp-cli/gttp/linux | bash</code>|

> [!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

0 comments on commit 84d4ee7

Please sign in to comment.