Added Generator section to README

This commit is contained in:
Sahat Yalkabov
2014-04-15 12:50:25 -04:00
parent 14e643ade5
commit 52324bb3f5

View File

@ -45,6 +45,7 @@ Table of Contents
- [Features](#features) - [Features](#features)
- [Prerequisites](#prerequisites) - [Prerequisites](#prerequisites)
- [Getting Started](#getting-started) - [Getting Started](#getting-started)
- [Generator](#generator)
- [Obtaining API Keys](#obtaining-api-keys) - [Obtaining API Keys](#obtaining-api-keys)
- [Project Structure](#project-structure) - [Project Structure](#project-structure)
- [List of Packages](#list-of-packages) - [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 restart the server each time you make a small change in code. To install, run
`sudo npm install -g nodemon`. `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 Obtaining API Keys
------------------ ------------------