Add a README

This commit is contained in:
TheFrenchGhosty 2022-09-04 14:31:43 +02:00
commit ec07a018fb

13
README.md Normal file
View file

@ -0,0 +1,13 @@
# breezewiki-quay
A [BreezeWiki](https://gitdab.com/cadence/breezewiki) image, on Quay.
[Quay page](https://quay.io/repository/pussthecatorg/breezewiki) | [GitHub page](https://github.com/PussTheCat-org/docker-breezewiki-quay)
This image mostly exist for the [PussTheCat.org](https://pussthecat.org/) instance (COMING SOON), but others are free to use it.
## Usage:
- Download (or copy the content of) the `docker-compose.yml`
- Move the docker-compose.yml file to the folder you want
- `docker-compose up -d`