Merge pull request #6 from simonireilly/patch/improve-readme-and-export

Improve the README with a quickstart example

README.md

@@ -12,10 +12,20 @@
 
 Currently programmatic usage is the only supported usage method:
 
+Create a new project with typeorm if you haven't got one
+
+```bash
+npx typeorm init --name basic --database postgres
+```
+
+Add the package as a dev dependency:
+
 ```bash
-yarn add typeorm-erd
+yarn add --dev typeorm-erd
 ```
 
+Render the ERD from your local machine:
+
 ```ts
 // src/data-source.ts
 import { MermaidErd } from "typeorm-erd";
@@ -52,7 +62,6 @@ erDiagram
 ## TODO
 
 - [ ] When relation is nullable use `o{` relation to show zero or more
-- [ ] Publish to NPM to allow usage in other modules
 
 ## Shoulders