Skip to content
This repository was archived by the owner on May 24, 2019. It is now read-only.

Commit fb52920

Browse files
noerwlafriks
authored andcommitted
Fix installation instructions (#11)
* improve README (#10) fix installation instructions, improve usage guide * Update README.md
1 parent ec4c0a4 commit fb52920

File tree

1 file changed

+17
-9
lines changed

1 file changed

+17
-9
lines changed

README.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,32 @@ This project acts as a command line tool for operating one or multiple Gitea ins
44
the Gitea API implementation.
55

66
## Installation
7-
7+
Currently no prebuilt binaries are provided.
8+
To install, a Go installation is needed.
9+
```sh
10+
go install code.gitea.io/tea
811
```
9-
go get github.com/go-gitea/tea
10-
go install github.com/go-gitea/tea
12+
13+
If the `tea` executable is not found, you might need to set up your `$GOPATH` and `$PATH` variables first:
14+
```sh
15+
export PATH=$PATH:$GOROOT/bin:$GOPATH/bin
1116
```
1217

1318
## Usage
14-
15-
First of all, you have to create a token on your personal settings -> application.
16-
17-
```
18-
git clone [email protected]:gitea/gitea.git
19-
cd gitea
19+
First of all, you have to create a token on your `personal settings -> application` page of your gitea instance.
20+
Use this token to login with `tea`:
21+
```sh
2022
tea login add --name=try --url=https://try.gitea.io --token=xxxxxx
23+
```
24+
25+
Now you can use the `tea` commands:
26+
```sh
2127
tea issues
2228
tea releases
2329
```
2430

31+
> If you are inside a git repository hosted on a gitea instance, you don't need to specify the `--login` and `--repo` flags!
32+
2533
## Contributing
2634

2735
Fork -> Patch -> Push -> Pull Request

0 commit comments

Comments
 (0)