From e96c70c226bbe4bcb9b8c7c201611ef7896278fc Mon Sep 17 00:00:00 2001 From: SeanCassiere <33615041+SeanCassiere@users.noreply.github.com> Date: Mon, 24 Jun 2024 09:28:17 +1200 Subject: [PATCH] chore: update readme --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e4d1646..b00b4e9 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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