Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
SeanCassiere committed Jun 23, 2024
1 parent 805264b commit e96c70c
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ This is a dead simple log server that allows you to log messages to a persisted
## Development

1. Clone the repository.
2. Install dependencies `npm install`.
2. Install dependencies `pnpm install`.
3. Create a `.env` file and add the necessary `secrets` into it. You can use the `.env.example` file as a reference.
4. Run the development server using `npm run dev`. If you haven't run an init on your database, run `npm run db:push`.
4. Run the development server using `pnpm run dev`. If you haven't run an init on your database, run `pnpm run db:push`.

## Usage

Expand All @@ -17,7 +17,7 @@ OpenAPI 3 specification with Swagger explorer is available at `/docs`.

To make any logs into the database, you'll need a valid service account which is active. These account should be regulated by yourself, and should not generated by the public.

You can use the `npm run db:explorer` to view the database, and create a service.
You can use the `pnpm run db:explorer` to view the database, and create a service.

### Endpoints

Expand Down

0 comments on commit e96c70c

Please sign in to comment.