Skip to content

Commit

Permalink
Update README.md, adding badges and editing build info
Browse files Browse the repository at this point in the history
  • Loading branch information
BRA1L0R committed Jul 19, 2022
1 parent 5e5b664 commit fda7099
Showing 1 changed file with 6 additions and 9 deletions.
15 changes: 6 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ There are two ways to run hopper:
- Using the [docker image](#docker)
- Using the [binaries](#binaries)

### Docker
### Docker ![GitHub Workflow Status](https://img.shields.io/github/workflow/status/bra1l0r/hopper-rs/Docker%20build%20and%20registry%20push?label=Container%20Build&style=flat-square)

- Pull the latest image from the GitHub registry:
```sh
Expand All @@ -61,11 +61,9 @@ services:
- ./Config.toml:/Config.toml
```
### Binary
### Binary ![GitHub Workflow Status](https://img.shields.io/github/workflow/status/bra1l0r/hopper-rs/Build%20and%20release%20on%20github?label=Artifact%20Release&style=flat-square)
You can either build the latest commit or download the [latest release](https://github.com/BRA1L0R/hopper-rs/releases)
#### BIY (Build-It-Yourself):
You can either download the [latest release](https://github.com/BRA1L0R/hopper-rs/releases) **(recommended)** or follow the steps below to build your own binary:
- Download and install the latest version of the rustc toolchain
- Clone and build the repo:
Expand All @@ -79,15 +77,14 @@ cargo build --release
```
- The runnable binary will now be available at `target/release/hopper`

#### Running the binary

TODO: running
TODO: running information with systemd configuration example

## TODO

- [x] write `Dockerfile` and `docker-compose.yml`
- [x] github ci / cd with code check, build and release
- [x] run and build documentation in readme
- [x] build documentation
- [x] run documentation in readme
- [x] restructure router trait
- [ ] add support for influxdb metrics (or similar)
- [ ] rest api for metrics and operation
Expand Down

0 comments on commit fda7099

Please sign in to comment.