chore: update readme

This commit is contained in:
hugeblank 2024-12-03 10:46:06 -08:00
parent 3e776018d6
commit 926305669b
2 changed files with 15 additions and 4 deletions

View file

@ -4,13 +4,15 @@ WhiteBreeze targets a single user and is meant for someone to self-host their Wh
## Usage
If for development:
### Development
```sh
npm install
npm run dev
```
If for production:
### Production
Change environment variables:
```sh
PUBLIC_HANDLE="myhandle.bsky.social" # Your handle, or DID
@ -18,9 +20,18 @@ PUBLIC_ABOUT="Welcome to my blog!" # Optional description of the kinds of posts
# PUBLIC_ABOUT Shows up under your Bluesky profile description in the profile card.
```
#### Standalone
```
npm install
npm run build
node index.js
```
Put environment variables ahead of the last command, port can also be configured with `PORT`.
Put environment variables ahead of the last command, port can also be configured with `PORT`.
#### Dockerized
Modify `docker-compose.yaml` and change the host port if necessary.
```
docker compose up
```

View file

@ -8,4 +8,4 @@ services:
restart: unless-stopped
env_file: ./.env
ports:
- 5000:3000
- 3000:3000 # host:container