Skip to content

Commit 5549e25

Browse files
committed
docs: update
1 parent 80c34a3 commit 5549e25

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

readme.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,20 @@ people are still waiting for gobinaries to update itself.
1313
**All credits to [tj](https://github.com/tj) for the idea and the initial
1414
implementation.**
1515

16+
- [goblin](#goblin)
17+
- [Why not fork?](#why-not-fork)
18+
- [Highlights](#highlights)
19+
- [Roadmap](#roadmap)
20+
- [Authors](#authors)
21+
- [Usage](#usage)
22+
- [Exposed API](#exposed-api)
23+
- [Deploy your own](#deploy-your-own)
24+
- [Existing Image](#existing-image)
25+
- [Using Docker](#using-docker)
26+
- [Using Traditional Servers](#using-traditional-servers)
27+
- [Configuration](#configuration)
28+
- [License](#license)
29+
1630
## Why not fork?
1731

1832
To keep it short, it's fun to build the arch from scratch, helps you learn. Also
@@ -44,6 +58,15 @@ original one)
4458

4559
You can read about it on [https://goblin.run](https://goblin.run)
4660

61+
## Exposed API
62+
63+
<small> from v0.4.0 </small>
64+
The server exposes a the following public routes usable for information
65+
66+
**`GET /version/<path>/<to>/<pkg>`**
67+
68+
- A `GET /version` request on a package path for example `github.com/barelyhuman/commitlog/v3` would give you the latest version resolved for it by comparing it on the goproxy and github's repo tags. This is the same algo used internally by Goblin and is available to you.
69+
4770
## Deploy your own
4871

4972
Since the entire reason for doing this was that delay on the original

0 commit comments

Comments
 (0)