MLH-Fellowship/nodemaker

Improving Nodemaker's DX

Closed this issue · 0 comments

ivov commented

Feedback from @ianjennings

  • Add .gitkeep to /build dir.
  • In the README, place the Installation section first and the Overview section second, and reorganize the ToC.
  • In the README, make it clearer how to run the app and CLI after installing.
  • In the README, move the installation process for the two official repos to the CLI reference. It's distracting.
  • In the README, delete the footnote on backend dependencies, because frontend dependencies are also required.
  • In the CLI Reference, clarify usage of the endpoint variable $$ in the Parameters section.
  • In the LICENSE, add Erin to the copyright notice.