From fb52920af9254e5746997c57745fc11b804106da Mon Sep 17 00:00:00 2001 From: Norwin Date: Fri, 12 Apr 2019 19:44:53 +0200 Subject: [PATCH] Fix installation instructions (#11) * improve README (#10) fix installation instructions, improve usage guide * Update README.md --- README.md | 26 +++++++++++++++++--------- 1 file changed, 17 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 65586ec..ee2ad88 100644 --- a/README.md +++ b/README.md @@ -4,24 +4,32 @@ This project acts as a command line tool for operating one or multiple Gitea ins the Gitea API implementation. ## 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 - -First of all, you have to create a token on your personal settings -> application. - -``` -git clone git@try.gitea.io:gitea/gitea.git -cd gitea +First of all, you have to create a token on your `personal settings -> application` page of your gitea instance. +Use this token to login with `tea`: +```sh tea login add --name=try --url=https://try.gitea.io --token=xxxxxx +``` + +Now you can use the `tea` commands: +```sh tea issues 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 Fork -> Patch -> Push -> Pull Request