documentation

.npmignore

@@ -0,0 +1 @@
+node_modules/

README.md

@@ -1,4 +1,33 @@
 generator-freedom
 =================
 
-Yeoman generator for freedom apps
+Yeoman generator for freedom.js web
+applications. Current capabilities:
+
+- fetch freedom.js (either regular or platform-specific flavors) from
+npm, bower, or [freedomjs.org](http://freedomjs.org/)
+- create appropriate freedom.js-specific boilerplate files for a
+  simple working demo application ([Counter]
+  (http://www.freedomjs.org/dist/freedom/latest/demo/counter/))
+- Perform various optional tasks:
+    - Initiate a git repository with appropriate .gitignore
+    - Create a Gruntfile with some useful tasks (installing needed npm packages)
+    - Installing Bootstrap from bower
+
+Current known issues:
+- Need to publish other freedom.js flavors to bower
+- Demo application only works with regular freedom.js (i.e. not
+  Chrome/Firefox/Node versions)
+- Could use more testing (i.e. it's not been run much on many
+  platforms -
+  [filing issues](https://github.com/freedomjs/generator-freedom/issues)
+  is very welcome!)
+
+Planned features:
+- Options to load in more advanced freedom.js functionality (see
+  [freedom.js interfaces](https://github.com/freedomjs/freedom/tree/master/interface))
+- Secondary generator to customize freedom app API (in manifest.json
+  file)
+- Boilerplate for tests and test running
+- Maybe more optional features/3rd party integration (make Git repo on
+  GitHub, test running on 3rd party services, packaging/deploying app, etc.)

app/USAGE

@@ -0,0 +1,14 @@
+Description:
+    Creates a basic freedom.js-powered web application
+
+Example:
+    yo freedom
+
+    This will create:
+        Gruntfile.js: Grunt tasks for building/running the application
+        package.json: Development packages installed by npm
+
+        src/index.html: Index for freedom.js application
+        src/main.js: Main application logic
+        src/manifest.json: Manifest describing API for freedom.js application
+        src/static/style.css: Initial stylesheet for demo application

app/index.js

@@ -113,7 +113,8 @@ module.exports = generators.Base.extend({
   setupgrunt: function () {
     if (gruntfile) {
       this.npmInstall(['grunt-contrib-clean', 'grunt-contrib-connect',
-                       'grunt-contrib-copy', 'grunt-contrib-jshint']);
+                       'grunt-contrib-copy', 'grunt-contrib-jshint'],
+                      { 'saveDev': true });
       var freedompath;
       if (freedomsource === 'npm') {
         freedompath = 'require.resolve(\'' + freedomtype + '\')';

app/templates/package.json

@@ -5,7 +5,7 @@
   "contributors": [
     "You <[email protected]>"
   ],
-  "dependencies": {
+  "devDependencies": {
     "grunt-contrib-clean": "^0.6.0",
     "grunt-contrib-connect": "^0.9.0",
     "grunt-contrib-copy": "^0.5.0",