diff --git a/README.md b/README.md index 0e942242b..c99788062 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456 [circleci-url]: https://circleci.com/gh/nestjs/nest - +
A progressive Node.js framework for building efficient and scalable server-side applications.
@@ -26,13 +26,13 @@
[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
-## Installation
+## Project setup
```bash
$ npm install
```
-## Running the app
+## Compile and run the project
```bash
# development
@@ -45,7 +45,7 @@ $ npm run start:dev
$ npm run start:prod
```
-## Test
+## Run tests
```bash
# unit tests
@@ -58,6 +58,18 @@ $ npm run test:e2e
$ npm run test:cov
```
+## Resources
+
+Check out a few resources that may come in handy when working with NestJS:
+
+- Visit the [NestJS Documentation](https://docs.nestjs.com) to learn more about the framework.
+- For questions and support, please visit our [Discord channel](https://discord.gg/G7Qnnhy).
+- To dive deeper and get more hands-on experience, check out our official video [courses](https://courses.nestjs.com/).
+- Visualize your application graph and interact with the NestJS application in real-time using [NestJS Devtools](https://devtools.nestjs.com).
+- Need help with your project (part-time to full-time)? Check out our official [enterprise support](https://enterprise.nestjs.com).
+- To stay in the loop and get updates, follow us on [X](https://x.com/nestframework) and [LinkedIn](https://linkedin.com/company/nestjs).
+- Looking for a job, or have a job to offer? Check out our official [Jobs board](https://jobs.nestjs.com).
+
## Support
Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
@@ -70,4 +82,4 @@ Nest is an MIT-licensed open source project. It can grow thanks to the sponsors
## License
- Nest is [MIT licensed](https://github.com/nestjs/nest/blob/master/LICENSE).
+Nest is [MIT licensed](https://github.com/nestjs/nest/blob/master/LICENSE).