add screenshots, improved README.md

This commit is contained in:
Adphi 2020-11-21 13:42:39 +01:00
parent b37ada9e82
commit f8e8b3d22c
3 changed files with 21 additions and 2 deletions

View File

@ -2,8 +2,19 @@
*go-repo* is a simple golang repository hosting web app, heavily inspired by [go.uber.org](https://go.uber.org).
It allows hosting go modules with custom import names,
e.g. `go.adphi.net/go-repo` instead of `git.adphi.net/adphi/go-repo`.
It allows hosting go modules with custom import names.
Example :
```bash
$ go get go.adphi.net/go-repo
```
instead of
```bash
$ go get git.adphi.net/adphi/go-repo
```
## Installation
```bash
@ -46,3 +57,11 @@ Run the app:
```bash
$ go-repo config.yml
```
## Screenshots
The origin display the available packages index
![index](screenshots/index.png)
The details page display the README.md from configuration
![details](screenshots/details.png)

BIN
screenshots/details.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 327 KiB

BIN
screenshots/index.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 49 KiB