readme: 0.5.0

Author: luxcgo

.goreleaser.yaml

@@ -7,12 +7,12 @@ before:
 builds:
   - binary: olive
 
-    main: ./src/cmd/olive
+    main: ./
     env:
       - CGO_ENABLED=0
 
     ldflags:
-      - -s -w -X github.com/go-olive/olive/src/config.AppVersion={{.Tag}}
+      - -s -w -X github.com/go-olive/olive/command.build={{.Tag}}
 
     goos:
       - linux
@@ -54,7 +54,7 @@ archives:
     files:
       - LICENSE
       - README.md
-      - src/tmpl/config.toml
+      - zarf/tmpl/config.toml
 
 checksum:
   name_template: "{{ .ProjectName }}_v{{ .Version }}_checksums.txt"

README.md

@@ -8,6 +8,55 @@
 [![Github All Releases](https://img.shields.io/github/downloads/go-olive/olive/total.svg?style=for-the-badge)](https://github.com/go-olive/olive/releases)
 [![QQGroup](https://img.shields.io/:QQ%20Group-735124170-brightgreen.svg?style=for-the-badge)](https://qm.qq.com/cgi-bin/qm/qr?k=c6CTyYkB-p-o8ZoT5ldcjuFAVnyu5vEL&jump_from=webapi)
 
-### Claimer
+[简体中文](https://go-olive.github.io/) | English
 
-main branch is currently WIP, check out [0.3.3](https://github.com/go-olive/olive/tree/0.3.3) instead.
+## Installation
+
+- build from source
+
+    `go install github.com/go-olive/olive@latest`
+
+- download from [**releases**](https://github.com/go-olive/olive/releases)
+
+- docker image
+    `docker pull luxcgo/olive`
+
+## Quickstart
+
+Get **olive** to work simply by passing the live url.
+
+```sh
+$ olive run -u https://www.huya.com/518512
+```
+
+## Usage
+
+```sh
+$ olive help
+
+olive is a live stream recorder, underneath there is a powerful engine
+which monitors streamers status and automatically records when they're 
+online. It helps you catch every live stream you want to see.
+
+Usage:
+  olive [command]
+
+Available Commands:
+  admin       Admin is a cli utility for database.
+  biliup      Biliup is a cli utility which generates bilibli cookies.
+  completion  Generate the autocompletion script for the specified shell
+  help        Help about any command
+  run         Start the olive engine.
+  server      Server provides olive-api support.
+  tv          TV is a cli utility which gets stream url.
+  version     Print the version number of olive
+
+Flags:
+  -h, --help   help for olive
+
+Use "olive [command] --help" for more information about a command.
+```
+
+## License
+
+This project is under the Apache-2.0. See the [LICENSE](https://github.com/go-olive/olive/blob/main/LICENSE) file for the full license text.