From 8d5eb3ec11223b67a3fb9c46b7260ba831aa7a0a Mon Sep 17 00:00:00 2001 From: Jayden Seric Date: Mon, 2 Oct 2017 16:51:21 +1100 Subject: [PATCH] Readme improvements. --- api/readme.md | 3 +++ app/readme.md | 12 +++++++----- 2 files changed, 10 insertions(+), 5 deletions(-) diff --git a/api/readme.md b/api/readme.md index 6f865db..04d10c1 100644 --- a/api/readme.md +++ b/api/readme.md @@ -15,7 +15,10 @@ An example GraphQL API using: 3. With Terminal in the `api` directory run `npm install`. 4. Run `npm run dev` for development, or `npm run start` for production. +Ensure your editor supports: +- [EditorConfig](http://editorconfig.org). +- [ESLint](http://eslint.org), respecting `package.json` config. [Atom](https://atom.io) users install [`linter-eslint`](https://atom.io/packages/linter-eslint) and enable `Fix errors on save`. ## Support diff --git a/app/readme.md b/app/readme.md index 44f0c92..4547abd 100644 --- a/app/readme.md +++ b/app/readme.md @@ -12,13 +12,15 @@ An example SSR web app using: ## Setup 1. Install the latest [Node.js](https://nodejs.org) and [npm](https://npmjs.com). -2. Run `npm install` within the `app` directory in Terminal. -3. Copy `.env.example`, rename it `.env` and customize. +2. Duplicate `.env.example` as `.env` and customize. +3. With Terminal in the `api` directory run `npm install`. +4. Run `npm run dev` for development, or `npm run build && npm run start` for production. -For development run `npm run dev`. +Ensure your editor supports: -For production run `npm run build && npm run start`. +- [EditorConfig](http://editorconfig.org). +- [ESLint](http://eslint.org), respecting `package.json` config. [Atom](https://atom.io) users install [`linter-eslint`](https://atom.io/packages/linter-eslint) and enable `Fix errors on save`. ## Support -See `engines` in `package.json`. +See `package.json` `engines`.