Skip to content

Commit

Permalink
docs: enhance readme (#8)
Browse files Browse the repository at this point in the history
  • Loading branch information
louisgrasset authored Aug 14, 2023
1 parent 933c111 commit a0d8603
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ git pull [email protected]:louisgrasset/touitomamout.git

**Install** dependencies & build the project
```bash
npm run ci && npm run build
npm ci && npm run build
```
## Configuration
Touitomamout relies on two APIs:
Expand Down Expand Up @@ -83,7 +83,10 @@ npm run deploy
Your instance will be removed and will be generated again with the latest codebase.
Your `cache.instance.json` file is kept, so you won't have duplicated toots.
```bash
npm run ci &&
npm ci &&
npm run build &&
npm run deploy:update
```

### Docker
You can alternatively rely on docker and use the `docker-compose.yml` file.

0 comments on commit a0d8603

Please sign in to comment.