README.md in skellington-0.8.0 vs README.md in skellington-0.8.1
- old
+ new
@@ -16,16 +16,32 @@
* [Bootstrap](http://getbootstrap.com/)
* [Compass](http://compass-style.org/)
* An MIT License file
* Jekyll
+ * [Jekyll](https://jekyllrb.com/)
* [Bootstrap](http://getbootstrap.com/)
* Reasonable default things
Should work fine for both RVM- and rbenv-based setups
- $ gem install skellington
+## Installation
+
+ git clone https://github.com/pikesley/skellington
+ cd skellington
+ bundle
+ rake
+ rake install
+
+or just
+
+ gem install skellington
+
+## Usage
+
+### Sinatra
+
$ skellington generate naming-things-is-hard --licensor 'Beyoncé'
Generating <lots of stuff>... done
Your new Sinatra app NamingThingsIsHard has been created
@@ -50,32 +66,52 @@
For post-install hints, try
skellington postinstall
-or
+### Jekyll
- skellington generate jekyll-site --framework jekyll
+ $ gem install skellington
+ $ skellington generate hello-from-the-magic-tavern --framework jekyll
Generating <lots of stuff>... done
- Your new Jekyll site JekyllSite has been created
+ Your new Jekyll site HelloFromTheMagicTavern has been created
- (Note that 'jekyll-site' has been changed to 'jekyll_site' because Ruby finds '-'s troubling)
+ (Note that 'hello-from-the-magic-tavern' has been changed to 'hello_from_the_magic_tavern' because Ruby finds '-'s troubling)
Now do
- cd jekyll_site
+ cd hello_from_the_magic_tavern
bundle
- bundle exec jekyll
+ bundle exec jekyll serve
which will launch the site (at http://localhost:4000)
And presuming that works OK
git add .
git commit -m 'First commit'
-This assumes a bunch of things, at least:
+ You should also fill in your name in LICENSE.md
+
+### Options
+
+* --framework
+ * Framework for which to generate
+ * Default: sinatra
+ * Possible values: sinatra, jekyll
+
+* --bootstrap
+ * Bootstrap major version to include
+ * Default: 3
+ * Possible values: 3, 4
+
+* --licensor
+ * Name to include in the license file
+
+---
+
+This all assumes a bunch of things, at least:
* That you have a reasonable git installation
Also, it will set up the new project using whatever version of ruby is cromulent when you run it