Proper help text & new README structure #311
33
README.md
33
README.md
|
@ -2,7 +2,7 @@
|
||||||
|
|
||||||
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT) [![Release](https://raster.shields.io/badge/dynamic/json.svg?label=release&url=https://gitea.com/api/v1/repos/gitea/tea/releases&query=$[0].tag_name)](https://gitea.com/gitea/tea/releases) [![Build Status](https://drone.gitea.com/api/badges/gitea/tea/status.svg)](https://drone.gitea.com/gitea/tea) [![Join the chat at https://img.shields.io/discord/322538954119184384.svg](https://img.shields.io/discord/322538954119184384.svg)](https://discord.gg/Gitea) [![Go Report Card](https://goreportcard.com/badge/code.gitea.io/tea)](https://goreportcard.com/report/code.gitea.io/tea) [![GoDoc](https://godoc.org/code.gitea.io/tea?status.svg)](https://godoc.org/code.gitea.io/tea)
|
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT) [![Release](https://raster.shields.io/badge/dynamic/json.svg?label=release&url=https://gitea.com/api/v1/repos/gitea/tea/releases&query=$[0].tag_name)](https://gitea.com/gitea/tea/releases) [![Build Status](https://drone.gitea.com/api/badges/gitea/tea/status.svg)](https://drone.gitea.com/gitea/tea) [![Join the chat at https://img.shields.io/discord/322538954119184384.svg](https://img.shields.io/discord/322538954119184384.svg)](https://discord.gg/Gitea) [![Go Report Card](https://goreportcard.com/badge/code.gitea.io/tea)](https://goreportcard.com/report/code.gitea.io/tea) [![GoDoc](https://godoc.org/code.gitea.io/tea?status.svg)](https://godoc.org/code.gitea.io/tea)
|
||||||
|
|
||||||
### the official CLI for gitea
|
### The official CLI for Gitea
|
||||||
|
|
||||||
noerw marked this conversation as resolved
|
|||||||
![demo gif](./demo.gif)
|
![demo gif](./demo.gif)
|
||||||
6543
commented
@techknowlogick can you update demo gif on dl.gitea.io with the gif of this pull? @techknowlogick can you update demo gif on dl.gitea.io with the gif of this pull?
|
|||||||
|
|
||||||
|
@ -71,25 +71,26 @@
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
You can use the prebuilt binaries from [dl.gitea.io](https://dl.gitea.io/tea/)
|
There are different ways to get `tea`:
|
||||||
|
|
||||||
Distribution packages exist for:
|
1. Install via your system package manager:
|
||||||
- **alpinelinux ([tea](https://pkgs.alpinelinux.org/packages?name=tea&branch=edge))**
|
- macOS via `brew` (gitea-maintained):
|
||||||
- **archlinux ([gitea-tea](https://aur.archlinux.org/packages/gitea-tea))**
|
```sh
|
||||||
|
brew tap gitea/tap https://gitea.com/gitea/homebrew-gitea
|
||||||
|
brew install tea
|
||||||
|
```
|
||||||
|
- arch linux ([gitea-tea](https://aur.archlinux.org/packages/gitea-tea), thirdparty)
|
||||||
|
- alpine linux ([tea](https://pkgs.alpinelinux.org/packages?name=tea&branch=edge), thirdparty)
|
||||||
|
|
||||||
To install from source, go 1.13 or newer is required:
|
2. Use the prebuilt binaries from [dl.gitea.io](https://dl.gitea.io/tea/)
|
||||||
|
|
||||||
```sh
|
3. Install from source (go 1.13 or newer is required):
|
||||||
go get code.gitea.io/tea
|
```sh
|
||||||
go install code.gitea.io/tea
|
go get code.gitea.io/tea
|
||||||
```
|
go install code.gitea.io/tea
|
||||||
|
```
|
||||||
noerw marked this conversation as resolved
Outdated
lunny
commented
I'd like to add I'd like to add `### macOS` before these lines and also move them before alphinelinux since this is an official one.
|
|||||||
|
|
||||||
If you have `brew` installed, you can install `tea` via:
|
4. Docker (thirdparty): [tgerczei/tea](https://hub.docker.com/r/tgerczei/tea)
|
||||||
|
|
||||||
```sh
|
|
||||||
brew tap gitea/tap https://gitea.com/gitea/homebrew-gitea
|
|
||||||
brew install tea
|
|
||||||
```
|
|
||||||
|
|
||||||
## Compilation
|
## Compilation
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue
Block a user
I would suggest to use
### The official CLI for gitea
instead.