From 2614853060800f9c36bd24e8216c12e093ce779f Mon Sep 17 00:00:00 2001 From: Chris Manson Date: Mon, 25 Jun 2018 10:04:05 +0100 Subject: [PATCH] making the readme slightly better --- README.md | 33 ++------------------------------- 1 file changed, 2 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index ac721a9..dc79827 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,13 @@ # authmaker-scopes-app -This README outlines the details of collaborating on this Ember application. -A short introduction of this app could easily go here. - -## Prerequisites - -You will need the following things properly installed on your computer. - -* [Git](https://git-scm.com/) -* [Node.js](https://nodejs.org/) (with npm) -* [Ember CLI](https://ember-cli.com/) -* [Google Chrome](https://google.com/chrome/) - -## Installation - -* `git clone ` this repository -* `cd my-app` -* `npm install` +This app powers the plan choice and subscription aspects of [Authmaker](https://authmaker.com). This app is consumed by the core Authmaker server as an NPM repository and is not intended to be run on its own. ## Running / Development -* `ember serve` +* `npm start` * Visit your app at [http://localhost:4200](http://localhost:4200). * Visit your tests at [http://localhost:4200/tests](http://localhost:4200/tests). -### Code Generators - -Make use of the many generators for code, try `ember help generate` for more details - ### Running Tests * `ember test` @@ -38,15 +18,6 @@ Make use of the many generators for code, try `ember help generate` for more det * `npm run lint:js` * `npm run lint:js -- --fix` -### Building - -* `ember build` (development) -* `ember build --environment production` (production) - -### Deploying - -Specify what it takes to deploy your app. - ## Further Reading / Useful Links * [ember.js](https://emberjs.com/)