Readme

Author: davguij

README.md

@@ -1,2 +1,22 @@
-# rest-nestjs-postgres
-CrudJS implemented as a REST API, using Nest and Postgres
+<img src="https://raw.githubusercontent.com/crudjs/rest-nestjs-postgres/master/resources/readme-header.jpg" width="100%" max-width="720px">
+
+# CrudJS + Nest.js + Postgres + TypeORM
+The CrudJS project implemented as a REST API, using Nest.js and Postgres.
+
+## What's this CrudJS thing?
+Glad that you asked. CrudJS intends to be a resource for comparing between different approaches for people building Node.js-based APIs, by applying them to an standard CRUD project. In other words, it's TodoMVC for APIs.
+
+You can learn more about the project at [our parent repository](https://github.com/crudjs/crudjs).
+
+## What's the stack used in this project?
+- **[Nest.js](https://nestjs.com/)** is a [TypeScript](https://www.typescriptlang.org/)-based Node.js API framework. It looks like if Angular and Express got physical. It's pretty knew and a bit rough around the edges, but [Kamil Myśliwiec](https://github.com/kamilmysliwiec) is doing an awesome job maintaining it.
+- **[Postgres](https://www.postgresql.org/)** is a very well know Open Source relational database.
+- **[TypeORM](https://typeorm.io/)** is an ORM built on [TypeScript](https://www.typescriptlang.org/), so it makes it a natural choice for Nest.js projects.
+- **[Jest](https://facebook.github.io/jest/)** is a testing platform from Facebook Code. It's easy to configure and provides out-of-the-box mocking and code coverage reporting.
+
+## Current version
+### 1.0.0-alpha.1
+*What's missing for 1.0.0 final?*
+- Unit tests with mocked up dependencies.
+- Secured POST & DELETE endpoints (other that /entries.)
+- Swagger definition generated from code.