Replace NX's README.md by the NXPM one

nxpm / stack

🥭 nxpm-stack lets you generate a complete and opinionated full-stack application in a Nx Workspace, ready to extend and deploy!

https://npm.im/@nxpm/stack

MIT License

108 stars 14 forks source link

Replace NX's README.md by the NXPM one #60

Closed ruslanguns closed 3 years ago

ruslanguns commented 3 years ago

Expected Behavior

It would be better to have NXPM README.md instead of the NX one since there are some instructions that are necessary.

Current Behavior

Currently the README.md is the one provided by the NX workspace.

Possible Solution

Replace README.md

beeman commented 3 years ago

This is a great point.

As a start, I think it would be nice to list similar instructions to those are currently printed after installation:

>  NXPM   INFO  Installation finished
>  NXPM   INFO  To get started         : cd my-stack
>  NXPM   INFO  Start database servers : docker-compose up
>  NXPM   INFO  Run setup              : yarn setup
>  NXPM   INFO  Start API              : yarn dev:api
>  NXPM   INFO  Start Web              : yarn dev:web

And probably a link to Nx' documentation. And very open for other suggestions.

ruslanguns commented 3 years ago

@beeman definitely an awesome idea!