Compare commits

...

3 Commits

Author SHA1 Message Date
d609f9bf43 Bump version number
All checks were successful
continuous-integration/drone/push Build is passing
continuous-integration/drone/tag Build is passing
2019-06-16 15:03:12 +02:00
6bc783451e Update README 2019-06-16 15:02:45 +02:00
21243e6cfb Document JSON endpoint on index page 2019-06-16 15:00:46 +02:00
4 changed files with 24 additions and 3 deletions

2
Cargo.lock generated
View File

@ -761,7 +761,7 @@ dependencies = [
[[package]]
name = "hoc"
version = "0.9.0"
version = "0.9.1"
dependencies = [
"actix-web 1.0.0 (registry+https://github.com/rust-lang/crates.io-index)",
"badge 0.2.0 (registry+https://github.com/rust-lang/crates.io-index)",

View File

@ -1,6 +1,6 @@
[package]
name = "hoc"
version = "0.9.0"
version = "0.9.1"
authors = ["Valentin Brandl <vbrandl@riseup.net>"]
edition = "2018"
build = "build.rs"

View File

@ -20,8 +20,14 @@ The API is as simple as
https://<host>/<service>/<user>/<repo>
```
where `<service>` is one of `gitub`, `gitlab` or `bitbucket`.
where `<service>` is one of `gitub`, `gitlab` or `bitbucket`. The HoC data can also be received as JSON by appending
`/json` to the reuqest path:
```
https://<host>/<service>/<user>/<repo>/json
```
There is also an overview page available via `https://<host>/view/<service>/<user>/<repo>`
## Building

View File

@ -45,6 +45,21 @@ would render this badge:
alt="example badge" /></a>
</pre>
<p>
You can also request the HoC as JSON by appending <code>/json</code> to the request path. This will return a JSON
object with two fields: <code>count</code> and <code>head</code> with count being the HoC value and head being the
commit ref of <code>HEAD</code>. Requesting
<a href="https://@domain/github/vbrandl/hoc/json">https://@domain/github/vbrandl/hoc/json</a> might return something
along the lines of
</p>
<pre>
&#123;
"head" : "05736ee3ba256ec9a7227c436aef2bf43db109ab",
"count": 7582
&#125;
</pre>
<h2>Badge Generator</h2>
<form method="post" action="/generate">