gn 0.0.1 → 0.0.1.1

data/Readme.md

@@ -2,50 +2,81 @@
 
 ## Description
 
-gn is the simplest file/folder/structure/whatever generator you could ever find. 
+gn is the simplest file/folder/structure/whatever generator you could
+ever find.
 
 ## Usage
 
-Say you want to generate always a typical README file, like this one, you should do the following:
+Say you want to generate always a typical `README` file, like this
+one, you should do the following:
 
-* Create a folder named (for instance) readme on your current folder
-* Inside of that folder, create a file named init.rb and fill it like this:
+Create a folder `readme` on your current folder and add an `init.rb`
+with the following content:
 
-        module Plan
-          module Readme
-            
-            def name 
-              "CHANGEME"
-            end
+```ruby
+module Plan
+  module Readme
 
-            def destination
-              "readme"
-            end
-          end
-        end
+    def name
+      "CHANGEME"
+    end
 
-* Create a templates folder and the template itself.
+    def destination
+      "readme"
+    end
+  end
+end
+```
 
-        mkdir readme/templates
-        touch readme/templates/readme.mote
+Create a `readme/templates` folder and add the template for your
+README files:
 
-* Inside the readme template, put your typical Readme content. 
-* To include dynamic data, just use {{variable}}, where variable is a public method on Plan::Readme. So writing {{name}} will produce CHANGEME.
+```
+mkdir readme/templates
+touch readme/templates/readme.mote
+```
 
-* Run the generator like this: 
+For example, add the following to the template:
 
-        gn readme
+```markdown
+# {{name}}
 
-* Your existing editor will pop open, allowing you to change the content of the module. 
-* Close the editor. 
-* You'll end up having a file named readme in the current directory, with the changes you made on the init.rb file, but your original init.rb file will be intact. 
+Copyright (c) 2012 Lucas Florio
+```
+
+Templates are rendered using [`mote`](http://soveran.github.com/mote),
+the minimalist template engine. In `mote` variable interpolation is
+done by using the `{{variable}}` syntax, as shown in the example
+above. Variable names are extracted from the current context, in this
+case the `Plan::Readme` module.
+
+Then run the generator like this:
+
+```
+gn readme
+```
+
+Now your default `$EDITOR` will pop open with a copy of your `init.rb`
+file, ready to be updated if necessary. **Note that your original
+`init.rb` file won't be modified**.
+
+Close your editor and done! Your `gn` generated `README` file will be
+placed in your current directory.
 
 ## Other usages
 
-You can use gn to generate different things. In our case, we design it so we could generate basic crud/scaffolds for cuba, but you could use for whatever you want. 
+You can use gn to generate different things. In our case, we design it
+so we could generate basic crud/scaffolds for
+[Cuba](http://soveran.github.com/cuba), but you could use it for
+whatever you want.
 
-See the folder named examples for some ideas. 
+See the folder named examples for some ideas.
 
 ## Installation
 
-    gem install gn
+```
+gem install gn
+```
+
+Given that `gn` is still in development process, you should add
+`--pre` to your `gem install`.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gn
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -15,7 +15,7 @@ date: 2012-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mote
-  requirement: &70315208785640 !ruby/object:Gem::Requirement
+  requirement: &70117254417960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,7 +23,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70315208785640
+  version_requirements: *70117254417960
 description: Simple Generator for the masses
 email:
 - lucasefe@gmail.com