Finish the readme.

Signed-off-by: Odyssey <odyssey346@disroot.org>
このコミットが含まれているのは:
Odyssey 2022-12-17 20:27:19 +01:00
コミット 05398f3831
1個のファイルの変更31行の追加4行の削除

ファイルの表示

@ -1,8 +1,35 @@
# gothub
# GotHub
Alternative front-end for GitHub written with Go.
Alternative front-end for GitHub written with Go. (WIP)
[Matrix](https://matrix.to/#/%23gothub%3Atrygve.me?via=projectsegfau.lt&via=vern.cc&via=matrix.org&via=trygve.me)
## [Matrix](https://matrix.to/#/%23gothub%3Atrygve.me?via=projectsegfau.lt&via=vern.cc&via=matrix.org&via=trygve.me)
## Features
- Lightweight - for both you and the instance host
- No JavaScript - pure HTML and CSS goodness
- No requests made to Micro$oft - they won't even know you made a request!
- Open source - for peer review & trustworthiness
- Save bandwidth - no JavaScript/tracking bloat loaded!
## Instances
The instances list is in the [wiki](https://codeberg.org/gothub/gothub/wiki/Instances).
### This project is still in development. ⚠️
## Setup
### Docker
We recommend Docker as it is easy to update GotHub that way and it is easy to setup.
[Packages page](https://codeberg.org/gothub/-/packages/container/gothub/latest)
```
docker run -d --name gothub codeberg.org/gothub/gothub
```
If you are using Portainer or Podman, you know how to create the GotHub container.
### Manual
You will need an installation of Go 1.19+ installed on your system.
```bash
git clone https://codeberg.org/gothub/gothub.git
cd gothub
go build -o gothub
./gothub serve
```
If you don't want to use port 3000 for GotHub, set the GOTHUB_PORT environment variable to the port you want to use.