chore: Update README.md

Author: BrunnerLivio

CONTRIBUTING.md

@@ -76,7 +76,7 @@ Before you submit your Pull Request (PR) consider the following guidelines:
   that relates to your submission. You don't want to duplicate effort.
 <!-- 1. Please sign our [Contributor License Agreement (CLA)](#cla) before sending PRs.
   We cannot accept code without this. -->
-1. Fork the nestjs/nest repo.
+1. Fork the nestjs/terminus repo.
 1. Make your changes in a new git branch:
 
      ```shell
@@ -85,7 +85,7 @@ Before you submit your Pull Request (PR) consider the following guidelines:
 
 1. Create your patch, **including appropriate test cases**.
 1. Follow our [Coding Rules](#rules).
-1. Run the full Nest test suite, as described in the [developer documentation][dev-doc],
+1. Run the full Nest test suite, as described in the README.md,
   and ensure that all tests pass.
 1. Commit your changes using a descriptive commit message that follows our
   [commit message conventions](#commit). Adherence to these conventions
@@ -102,7 +102,7 @@ Before you submit your Pull Request (PR) consider the following guidelines:
     git push origin my-fix-branch
     ```
 
-1. In GitHub, send a pull request to `nestjs:master`.
+1. In GitHub, send a pull request to `nestjs/terminus:master`.
 * If we suggest changes then:
   * Make the required updates.
   * Re-run the Nest test suites to ensure tests are still passing.
@@ -148,12 +148,6 @@ from the main (upstream) repository:
 To ensure consistency throughout the source code, keep these rules in mind as you are working:
 
 * All features or bug fixes **must be tested** by one or more specs (unit-tests).
-<!--
-// We're working on auto-documentation.
-* All public API methods **must be documented**. (Details TBC). -->
-* We follow [Google's JavaScript Style Guide][js-style-guide], but wrap all code at
-  **100 characters**. An automated formatter is available, see
-  [DEVELOPER.md](docs/DEVELOPER.md#clang-format).
 
 ## <a name="commit"></a> Commit Message Guidelines
 
@@ -180,13 +174,13 @@ to read on GitHub as well as in various git tools.
 
 Footer should contain a [closing reference to an issue](https://help.github.com/articles/closing-issues-via-commit-messages/) if any.
 
-Samples: (even more [samples](https://github.com/nestjs/nest/commits/master))
+Samples: (even more [samples](https://github.com/nestjs/terminus/commits/master))
 
 ```
-docs(changelog) update change log to beta.5
+docs: update change log to beta.5
 ```
 ```
-fix(@nestjs/core) need to depend on latest rxjs and zone.js
+fix: need to depend on latest rxjs and zone.js
 
 The version in our package.json gets copied to the one we publish, and users need the latest of these.
 ```
@@ -242,7 +236,6 @@ changes to be accepted, the CLA must be signed. It's a quick process, we promise
 <!-- [coc]: https://github.com/angular/code-of-conduct/blob/master/CODE_OF_CONDUCT.md -->
 [commit-message-format]: https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#
 [corporate-cla]: http://code.google.com/legal/corporate-cla-v1.0.html
-[dev-doc]: https://github.com/nestjs/nest/blob/master/docs/DEVELOPER.md
 [github]: https://github.com/nestjs/nest
 [discord]: https://discord.gg/nestjs
 [individual-cla]: http://code.google.com/legal/individual-cla-v1.0.html

README.md

@@ -107,25 +107,36 @@ Setup the development environment by following these instructions:
 2. Install the dependencies
 
 ```bash
-npm install
+pnpm i
+pnpm dev
+```
+
+In order to test the library against a sample, simply go to a sample and run
+`pnpm start:dev`
 
-# To rebuild the project, run
-npm run build
+```typescript
+cd sample/000-dogs-app
+pnpm start:dev
 ```
 
+> [!NOTE] 
+> Once the library is rebuilt, the `pnpm start:dev` within a sample
+> needs to be restarted in order to pick up the changes.
+
 ### Test
 
 For unit testing run the following command:
 
 ```bash
-npm run test
+pnpm test
 ```
 
-For e2e testing, make sure you have docker installed
+For e2e testing, a Docker Compose stack is required. Make sure
+Docker is installed on your machine and run the following command.
 
 ```bash
-docker-compose up -d
-npm run test:e2e
+docker compose up -d
+pnpm test:e2e
 ```
 
 ## Support

package.json

@@ -13,8 +13,8 @@
     "dev": "tsc -p tsconfig.build.json --watch",
     "build": "tsc -p tsconfig.build.json && pnpm copy:proto",
     "copy:proto": "copyfiles lib/health-indicator/microservice/protos/health.proto dist/health-indicator/microservice/protos/health.proto",
-    "build:all": "npm run build && pnpm run -r build",
-    "test:all": "npm run test && pnpm run -if-present -r test --passWithNoTests",
+    "build:all": "pnpm run build && pnpm run -r build",
+    "test:all": "pnpm run test && pnpm run -if-present -r test --passWithNoTests",
     "test:e2e:all": "npm run test:e2e && pnpm run --if-present -r e2e --passWithNoTests",
     "format": "prettier --check \"{lib,e2e,sample,tools}/**/*.ts\"",
     "format:fix": "prettier --write \"{lib,e2e,sample,tools}/**/*.ts\"",
@@ -26,10 +26,10 @@
     "publish:next": "npm publish --access public --tag next",
     "prepublish:npm": "npm run build",
     "publish:npm": "npm publish --access public",
-    "test": "npm run test:ut && npm run test:import",
+    "test": "pnpm run test:ut && pnpm run test:import",
     "test:e2e": "jest --config=e2e/jest-e2e.json --detectOpenHandles --forceExit",
     "test:ut": "jest --detectOpenHandles",
-    "test:ut:cov": "npm run test:ut -- --coverage",
+    "test:ut:cov": "pnpm run test:ut -- --coverage",
     "test:import": "ts-node tools/import-check.ts",
     "release": "release-it",
     "prepare": "husky install"