Merge lp:~stephen-stewart/online-services-common-js/add-npmignore into lp:online-services-common-js

[Stephen Stewart]

Add npmignore file, remove 'base' property from the modules obect and explain in README how a user should set this themselves.

Add npmignore file, update README

[Jonas G. Drange (jonas-drange)]

LGTM

review: Approve

=== added file '.npmignore'
--- .npmignore	1970-01-01 00:00:00 +0000
+++ .npmignore	2014-03-05 13:16:02 +0000
@@ -0,0 +1,4 @@
+.bzr*
+import.sh
+bower_components
+release
 
=== modified file 'Gruntfile.js'
--- Gruntfile.js	2014-03-04 11:22:55 +0000
+++ Gruntfile.js	2014-03-05 13:16:02 +0000
@@ -140,10 +140,10 @@
         },
 
         modules: {
-            u1: {
+            // online services modules
+            os: {
                 src: ['./src/**/build.json'],
-                dest: './build/config.js',
-                base: '/convoy'
+                dest: './build/config.js'
             }
         },
 
@@ -290,14 +290,9 @@
             config = {},
             out = '',
             group = this.target,
-            base = this.data.base,
             template = this.data.tmpl ||
                 'YUI.GlobalConfig = <%= config %>;';
 
-        if (!base) {
-            throw new Error('need base path for YUI config');
-        }
-
         this.filesSrc.forEach(function(filepath) {
             var meta = grunt.file.readJSON(filepath),
                 key;
@@ -327,7 +322,6 @@
 
         config.groups = {};
         config.groups[group] = {};
-        config.groups[group].base = base;
         config.groups[group].modules = modules;
 
         out = grunt.template.process(template, {data: {config: JSON.stringify(config) }});
 
=== modified file 'README.md'
--- README.md	2014-03-04 11:22:55 +0000
+++ README.md	2014-03-05 13:16:02 +0000
@@ -1,9 +1,32 @@
 
 Ubuntu Common YUI Module Library
-==========================================
-
-
-Install nodejs
+================================
+
+Simple Usage
+------------
+
+'''
+npm install online-services-common-js
+'''
+
+Link YUI and the Online Services YUI module config in your HTML document:
+'''
+<script src="node_modules/online-services-common-js/build/config.js"></script>
+<!--
+set up config to let YUI know where to find your modules, combo loader, etc.
+http://yuilibrary.com/yui/docs/yui/
+-->
+<script>
+// the group name is 'os'
+YUI.GlobalConfig.groups.os.combine = false;
+YUI.GlobalConfig.groups.os.base = 'node_modules/build/';
+</script>
+'''
+
+Hacking
+-------
+
+Install nodejs:
 
 '''
 sudo apt-get update
@@ -13,16 +36,20 @@
 sudo apt-get install nodejs
 '''
 
-Install global npm deps
+Install dev dependencies, either from within module in node\_modules or within a
+online-services-common-js branch:
+
 '''
-npm install -g grunt-cli bower grover shifter yeti
 npm install
+bower install
 '''
 
+(Bower is used to install YUI for testing purposes)
+
 
 Available Grunt tasks
 '''
 grunt build
 grunt test
-grunt watch
+grunt run # 'watch'
 '''
 
=== modified file 'build/config.js'
--- build/config.js	2014-03-04 12:15:23 +0000
+++ build/config.js	2014-03-05 13:16:02 +0000
@@ -1,1 +1,1 @@
-YUI.GlobalConfig = {"groups":{"u1":{"base":"/convoy","modules":{"global-navigation-templates":{"requires":["template"]},"global-navigation":{"requires":["node","template","array-extras","global-navigation-templates"],"skinnable":true},"password-meter":{"requires":["base","widget","event-key","transition"],"skinnable":true},"plugin-jit-bar":{"requires":["anim","node","node-scroll-info","plugin"],"skinnable":true},"plugin-panel-anim":{"requires":["plugin","base-build","event-custom","transition"]},"rangyinputs":{},"uploader":{"requires":["array-extras","uploader-html5"]},"uploader-follow":{"requires":["base","anim"]},"util-share":{"requires":["base","node"]},"util-stacktrace":{"requires":[]},"util-oops":{"requires":["base","io-base","json-stringify"]},"util":{"use":["util-share","util-stacktrace","util-oops"]},"widget-cc-input":{"requires":["node-pluginhost","widget","base","transition","button","rangyinputs","template"],"skinnable":true},"position-sticky":{"requires":["widget","substitute","node","event-resize"]},"widget-tooltip":{"requires":["event-mouseenter","widget","widget-position","widget-position-align","widget-stack","escape"],"skinnable":true}}}}};
 \ No newline at end of file
+YUI.GlobalConfig = {"groups":{"os":{"modules":{"global-navigation-templates":{"requires":["template"]},"global-navigation":{"requires":["node","template","array-extras","global-navigation-templates"],"skinnable":true},"password-meter":{"requires":["base","widget","event-key","transition"],"skinnable":true},"plugin-jit-bar":{"requires":["anim","node","node-scroll-info","plugin"],"skinnable":true},"plugin-panel-anim":{"requires":["plugin","base-build","event-custom","transition"]},"rangyinputs":{},"uploader":{"requires":["array-extras","uploader-html5"]},"uploader-follow":{"requires":["base","anim"]},"util-share":{"requires":["base","node"]},"util-stacktrace":{"requires":[]},"util-oops":{"requires":["base","io-base","json-stringify"]},"util":{"use":["util-share","util-stacktrace","util-oops"]},"widget-cc-input":{"requires":["node-pluginhost","widget","base","transition","button","rangyinputs","template"],"skinnable":true},"position-sticky":{"requires":["widget","substitute","node","event-resize"]},"widget-tooltip":{"requires":["event-mouseenter","widget","widget-position","widget-position-align","widget-stack","escape"],"skinnable":true}}}}};
 \ No newline at end of file
 
=== modified file 'package.json'
--- package.json	2014-02-23 01:21:56 +0000
+++ package.json	2014-03-05 13:16:02 +0000
@@ -1,13 +1,13 @@
 {
   "name": "online-services-common-js",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "online services yui modules",
   "homepage": "https://launchpad.net/online-services-common-js",
   "bugs": "https://bugs.launchpad.net/online-services-common-js",
   "files": "build",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "postinstall": "bower install"
+    "prepublish": "bower install && grunt build"
   },
   "repository": {
       "type": "bzr",