Proper help text & new README structure #311
Merged
lunny
merged 11 commits from noerw/tea:improve-app-help
into master
2 years ago
Loading…
Reference in new issue
There is no content yet.
Delete Branch 'noerw/tea:improve-app-help'
Deleting a branch is permanent. It CANNOT be undone. Continue?
tea
,tea help
,tea --help
, now including a proper description, examples, about, ..Usage
section of the README with rawtea help
output: IMO having a different text in the readme is a lame excuse to not ship good help in the binary.tea --version
output only the version, for enhanced parseability (breaking?)let me know what you think
preview the new readme here
Tea is a command line tool for interacting on one or more Gitea instances.
It uses [code.gitea.io/sdk](https://code.gitea.io/sdk) and interacts with the Gitea API

@techknowlogick can you update demo gif on dl.gitea.io with the gif of this pull?

```
tea - command line tool to interact with Gitea
version 0.6.0+17-g1c10f33
version 0.7.0 preview ... or so (should be changed on release)
}
var appDescription = `tea is a productivity helper for Gitea. It can be used to manage most entities on one
or multiple Gitea instances, and also provides local helpers like 'tea pull checkout'.
brew install tea
I'd like to add
### macOS
before these lines and also move them before alphinelinux since this is an official one.Otherwise LGTM
## The official CLI interface for gitea
### the official CLI for gitea
I would suggest to use
### The official CLI for gitea
instead.43a58bdba1
into master 2 years ago43a58bdba1
.