actions
/
tea
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix installation instructions (#11) 

* improve README (#10)

fix installation instructions, improve usage guide

* Update README.md
This commit is contained in:
Norwin 2019-04-12 19:44:53 +02:00 committed by Lauris BH
parent ec4c0a4690
commit fb52920af9
1 changed files with 17 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -4,24 +4,32 @@ This project acts as a command line tool for operating one or multiple Gitea ins
the Gitea API implementation. the Gitea API implementation.
## Installation ## Installation
Currently no prebuilt binaries are provided.
To install, a Go installation is needed.
```sh
go install code.gitea.io/tea
``` ```
go get github.com/go-gitea/tea
go install github.com/go-gitea/tea If the `tea` executable is not found, you might need to set up your `$GOPATH` and `$PATH` variables first:
```sh
export PATH=$PATH:$GOROOT/bin:$GOPATH/bin
``` ```
## Usage ## Usage
First of all, you have to create a token on your `personal settings -> application` page of your gitea instance.
First of all, you have to create a token on your personal settings -> application. Use this token to login with `tea`:
```sh
```
git clone git@try.gitea.io:gitea/gitea.git
cd gitea
tea login add --name=try --url=https://try.gitea.io --token=xxxxxx tea login add --name=try --url=https://try.gitea.io --token=xxxxxx
```
Now you can use the `tea` commands:
```sh
tea issues tea issues
tea releases tea releases
``` ```
> If you are inside a git repository hosted on a gitea instance, you don't need to specify the `--login` and `--repo` flags!
## Contributing ## Contributing
Fork -> Patch -> Push -> Pull Request Fork -> Patch -> Push -> Pull Request