update readme

pull/3/head
Ben Phelps 2 years ago
parent 871b63d70e
commit 5c3d6f913e

@ -1,5 +1,34 @@
## Getting Started ## Getting Started
Using docker compose:
```yaml
version: '3.3'
services:
homepage:
image: ghcr.io/benphelps/homepage:main
container_name: homepage
ports:
- 3000:3000
volumes:
- /path/to/config:/app/config
```
or docker run:
```bash
docker run -p 3000:3000 -v /path/to/config:/app/config ghcr.io/benphelps/homepage:main
```
## Configuration
Configuration files will be genereted and placed on the first request.
Configuration is done in the /config directory using .yaml files. Refer to each config for
the specific configuration options.
## Development
Install NPM packages, this project uses [pnpm](https://pnpm.io/) (and so should you!): Install NPM packages, this project uses [pnpm](https://pnpm.io/) (and so should you!):
```bash ```bash
@ -13,9 +42,3 @@ pnpm dev
``` ```
Open [http://localhost:3000](http://localhost:3000) to start. Open [http://localhost:3000](http://localhost:3000) to start.
## Configuration
Configuration is done in the /config directory using .yaml files. Refer to each config for
the specific configuration options.

Loading…
Cancel
Save