diff --git a/README.md b/README.md index e88baef6e5..a3857a0ced 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,47 @@ # docs.nestjs.com +

+ Nest Logo +

+ +[travis-image]: https://api.travis-ci.org/nestjs/nest.svg?branch=master +[travis-url]: https://travis-ci.org/nestjs/nest +[linux-image]: https://img.shields.io/travis/nestjs/nest/master.svg?label=linux +[linux-url]: https://travis-ci.org/nestjs/nest + +

A progressive Node.js framework for building efficient and scalable web applications. :cat:

+

+NPM Version +Package License +NPM Downloads +Travis +Linux +Coverage +Gitter +Backers on Open Collective +Sponsors on Open Collective +

+ + This project is built on top of [Angular CLI](https://github.com/angular/angular-cli). -## Development server +## Developing -Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files. +Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files. + +``` +$ npm install +$ npm run start +``` ## Build Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `-prod` flag for a production build. + + +## People + +- Author - [Kamil Myƛliwiec](https://kamilmysliwiec.com) +- Website - [https://nestjs.com](https://nestjs.com/) +