Merge branch 'release-0.0.0'

v0.0.0

.gitignore

@@ -0,0 +1,5 @@
+# bats installation
+bats/
+
+# npm installed modules
+node_modules/

Gruntfile.js

@@ -0,0 +1,22 @@
+/**
+ * grunt tasks
+ * https://github.com/GochoMugo/grunt-install
+ *
+ * Copyright (c) 2014-2015 Forfuture LLC
+ * Licensed under the MIT License
+ */
+
+
+module.exports = function(grunt) {
+  grunt.initConfig({
+    jshint: {
+      template: {
+        src: ["Gruntfile.js", "lib/template.js"]
+      }
+    }
+  });
+
+  grunt.loadNpmTasks("grunt-contrib-jshint");
+
+  grunt.registerTask("default", ["jshint"]);
+};

LICENSE

@@ -1,22 +1,25 @@
 The MIT License (MIT)
 
-Copyright (c) 2014 GOCHO MUGO I.
+Copyright (c) 2014-2015 Gocho Mugo <[email protected]>
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the Software
+without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to
+whom the Software is furnished to do so, subject to the
+following conditions:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+The above copyright notice and this permission notice shall
+be included in all copies or substantial portions of the
+Software.
 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
+KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
+PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
+OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Makefile

@@ -0,0 +1,21 @@
+# Makefile for Developers and CI
+# https://github.com/GochoMugo/grunt-install
+#
+# Copyright (c) 2014-2015 Gocho Mugo <[email protected]>
+# Licensed under the MIT License
+
+test:
+	GRUNT_INSTALL_UNIT_TEST="test" ./bats/bin/bats test/test.install.sh
+	GRUNT_INSTALL_UNIT_TEST="test" ./bats/bin/bats test/test.grunt-install.sh
+	grunt
+	make clean
+
+deps:
+	git clone https://github.com/sstephenson/bats.git bats
+	npm install
+
+
+clean:
+	rm -rf _TEST_* npm-debug.log
+
+.PHONY: test clean

README.md

@@ -0,0 +1,159 @@
+
+# grunt-install
+
+Simple Bash script for Grunt template installation
+
+
+## installation:
+
+This method clones the Github repository and runs the `install.sh` script in
+ the newly-created directory. The last command may require `sudo`.
+
+```bash
+⇒ git clone https://github.com/GochoMugo/grunt-install.git
+⇒ cd grunt-install
+⇒ ./install.sh
+```
+
+
+## usage:
+
+__grunt-install__ allows you to install Grunt templates from both Github
+ and NPM online registry with much ease.
+
+To install a template from Github, such as [this one][esta], simply run:
+
+```bash
+⇒ grunt-install forfuture-dev/grunt-template-esta MyTemplate
+```
+
+This uses a Github shorthand which will be expanded to match the Github
+ Repository URL. You also provide a name, in this case `MyTemplate`, that
+ will be given to the template.
+
+You may also install templates from NPM online registry, by simply
+ running:
+
+```bash
+⇒ grunt-install grunt-template-esta MyTemplate
+```
+
+Once templates are installed, you may now use [grunt-init][grunt-init] to
+ initiate a Grunt project.
+
+```bash
+⇒ grunt-init MyTemplate
+```
+
+
+## tips:
+
+Lets say we version bump and you want to upgrade to the latest version
+ __grunt-install__, it is simple (you may require `sudo`):
+
+```bash
+⇒ grunt-install --upgrade
+```
+
+In the spirit of keeping up to date, you want to update your templates:
+
+```bash
+⇒ grunt-install --update
+```
+
+If you ever want to replace a template with another while installing, you
+ could simply use the `--force` option. Example:
+
+```bash
+⇒ grunt-install --force forfuture-dev/grunt-template-esta esta
+```
+
+Setting the environment variable `GRUNT_INSTALL_NO_COLOR` will
+ disable colored output. If you just don't want to see any output at all,
+ you could simply use the `--silent` option.
+
+
+## help information:
+
+```bash
+⇒ grunt-install --help
+grunt-install 0.0.0
+
+Usage: grunt-install [install_options] <URI> <template_name>
+
+Where <URI> can be:
+    UserName/RepoName    github shorthand
+    PackageName          npm package name
+
+Install Options:
+    -f,  --force         Force installation
+    -s,  --silent        Be Silent
+
+More Options:
+    -h,  --help          Show this help information
+    -u,  --update        Update installed templates
+    -up, --upgrade       Upgrade grunt-install
+    -v,  --version       Show version information
+
+Examples:
+    grunt-install forfuture-dev/grunt-template-esta MyTemplate
+    grunt-install grunt-template-esta AwesomeNess
+```
+
+
+## available templates:
+
+Here is a list of grunt templates you may be interested in. You can install
+ them using the label shown.
+
+* [forfuture-dev/grunt-template-esta][esta] (`⇒ grunt-install forfuture-dev/grunt-template-esta MyPreferredName` will just do)
+* [mathiasbynens/grunt-template](https://github.com/mathiasbynens/grunt-template)
+* [leemunroe/grunt-email-design](https://github.com/leemunroe/grunt-email-design)
+* [dwightjack/grunt-email-boilerplate](https://github.com/dwightjack/grunt-email-boilerplate)
+* [fooplugins/grunt-wp-boilerplate](https://github.com/fooplugins/grunt-wp-boilerplate)
+* [eunjae-lee/node-express-grunt-boilerplate](https://github.com/eunjae-lee/node-express-grunt-boilerplate)
+* [ghost-town/grunt-init-assemble](https://github.com/ghost-town/grunt-init-assemble)
+
+
+## contribution:
+
+Hands-on the `develop` branch. Don't touch `master`, only stable release
+ branches are merged into it.
+
+Tests are run using [bats][bats]. Please accompany PR's with relevant
+ tests. Issues are tracked from [here][issues].
+
+
+## license:
+
+__The MIT License (MIT)__
+
+Copyright (c) 2014 Gocho Mugo <[email protected]>
+
+Permission is hereby granted, free of charge, to any person
+ obtaining a copy of this software and associated
+ documentation files (the "Software"), to deal in the Software
+ without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense,
+ and/or sell copies of the Software, and to permit persons to
+ whom the Software is furnished to do so, subject to the
+ following conditions:
+
+The above copyright notice and this permission notice shall
+ be included in all copies or substantial portions of the
+ Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
+ KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+ WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
+ PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
+ OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+ OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+ OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+
+[bats]:https://github.com/sstephenson/bats "Bash Automated Testing System"
+[esta]:https://github.com/forfuture-dev/grunt-template-esta
+[grunt-init]:https://github.com/gruntjs/grunt-init
+[issues]:https://github.com/GochoMugo/grunt-install/issues