From 52324bb3f50fd4b1fea2268e920e57f841dc6760 Mon Sep 17 00:00:00 2001 From: Sahat Yalkabov Date: Tue, 15 Apr 2014 12:50:25 -0400 Subject: [PATCH] Added Generator section to README --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index e5c1b8c570..8c11948e56 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,7 @@ Table of Contents - [Features](#features) - [Prerequisites](#prerequisites) - [Getting Started](#getting-started) +- [Generator](#generator) - [Obtaining API Keys](#obtaining-api-keys) - [Project Structure](#project-structure) - [List of Packages](#list-of-packages) @@ -126,6 +127,24 @@ save you a lot of time in the long run, because you won't need to manually restart the server each time you make a small change in code. To install, run `sudo npm install -g nodemon`. +Generator +--------- + +Hackathon Starter Generator is still in alpha stage. It is tighly tied to the +project code. As soon as you start changing and moving things around, it will +probably no longer work as expected. That is why it's best to use when you first +download Hackathon Starter. + +:exclamation: **Note:** Generator has a "destructive" behavior, it will physically +modify your code. *There is no undo action.* To be on a safe side, always commit +your code to Git, so you could go back and undo the changes. + +Currently it supports adding/removing authentication providers and switching +between SendGrid/Mailgun email services. In the future you'll be able to use +it to quickly add Socket.io support to your app, add Mozilla Persona sign-in, +generate new pages (create new routes, templates and controllers for you +automatically). + Obtaining API Keys ------------------