knife-cookbook-readme 0.1.1 → 0.1.2

data/.gitignore

@@ -3,6 +3,7 @@
 .bundle
 .config
 coverage
+Gemfile.lock
 InstalledFiles
 lib/bundler/man
 pkg

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+v0.1.2 (Jul 17 2013)
+--------------------
+
+* Add title to generated README and decrease level of headings.
+* Rename "templates" directory to "template".
+* Add alternative Chef documentation tools to README.
+* Remove Gemfile.lock.
+
 v0.1.1 (Feb 20 2013)
 --------------------
 

data/README.md

@@ -49,6 +49,16 @@ Note that the command will write the generated output to STDOUT. Simply redirect
 the output to `README.md` to write to a file.
 
 
+Alternatives
+------------
+
+Here is a list of other documentation tools for Chef (sorted alphabetically):
+
+* [knife-cookbook-doc](https://github.com/realityforge/knife-cookbook-doc)
+  ([blog post](http://realityforge.org/code/2013/04/01/documenting-cookbooks.html))
+* [yard-chef](https://github.com/rightscale/yard-chef)
+
+
 License
 -------
 

data/lib/chef/knife/cookbook_readme_from.rb

@@ -21,7 +21,7 @@ module KnifeCookbookReadme
     option :template_file,
            :short       => '-t',
            :long        => '--template FILE',
-           :default     => File.expand_path('../../../../templates/README.md.erb',
+           :default     => File.expand_path('../../../../template/README.md.erb',
                                             Pathname.new(__FILE__).realpath),
            :description => 'Set template file used to render README.md'
 

data/lib/knife_cookbook_readme/readme_model.rb

@@ -7,6 +7,10 @@ module KnifeCookbookReadme
       @constraints = constraints
     end
 
+    def title
+      "#{@metadata.name.capitalize} Cookbook"
+    end
+
     def description
       @metadata.description
     end

data/lib/knife_cookbook_readme/version.rb

@@ -1,3 +1,3 @@
 module KnifeCookbookReadme
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/{templates → template}/README.md.erb

@@ -1,12 +1,12 @@
-Description
-===========
+<%= title %>
+<%= '=' * title.length %>
 
 <%= description %>
 
 Requirements
-============
+------------
 
-## Platform:
+### Platform:
 
 <% unless platforms.empty? %>
 <% platforms.each do |platform| %>
@@ -16,7 +16,7 @@ Requirements
 *No platforms defined*
 <% end %>
 
-## Cookbooks:
+### Cookbooks:
 
 <% unless dependencies.empty? %>
 <% dependencies.each do |cookbook| %>
@@ -27,7 +27,7 @@ Requirements
 <% end %>
 
 Attributes
-==========
+----------
 
 <% unless attributes.empty? %>
 <table>
@@ -49,11 +49,11 @@ Attributes
 <% end %>
 
 Recipes
-=======
+-------
 
 <% unless recipes.empty? %>
 <% recipes.each do |recipe, description| %>
-## <%= recipe %>
+### <%= recipe %>
 
 <%= description %>
 
@@ -63,7 +63,7 @@ Recipes
 <% end %>
 
 License and Author
-==================
+------------------
 
 Author:: <%= author %> (<<%= author_email %>>)
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: knife-cookbook-readme
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,14 +9,14 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-20 00:00:00.000000000 Z
+date: 2013-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
@@ -24,7 +24,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -32,7 +32,7 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
@@ -40,7 +40,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -48,7 +48,7 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
@@ -56,7 +56,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Knife plugin to generate README.md from metadata.rb
@@ -69,7 +69,6 @@ files:
 - .gitignore
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -77,7 +76,7 @@ files:
 - lib/chef/knife/cookbook_readme_from.rb
 - lib/knife_cookbook_readme/readme_model.rb
 - lib/knife_cookbook_readme/version.rb
-- templates/README.md.erb
+- template/README.md.erb
 homepage: http://mlafeldt.github.com/knife-cookbook-readme
 licenses:
 - Apache 2.0
@@ -88,21 +87,21 @@ require_paths:
 required_ruby_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
       segments:
       - 0
-      hash: -369444156399340514
+      hash: -921780819663544875
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
       segments:
       - 0
-      hash: -369444156399340514
+      hash: -921780819663544875
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25

data/Gemfile.lock

@@ -1,61 +0,0 @@
-PATH
-  remote: .
-  specs:
-    knife-cookbook-readme (0.1.1)
-      chef
-      erubis
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    chef (11.4.0)
-      erubis
-      highline (>= 1.6.9)
-      json (>= 1.4.4, <= 1.7.7)
-      mixlib-authentication (>= 1.3.0)
-      mixlib-cli (~> 1.3.0)
-      mixlib-config (>= 1.1.2)
-      mixlib-log (>= 1.3.0)
-      mixlib-shellout
-      net-ssh (~> 2.6)
-      net-ssh-multi (~> 1.1.0)
-      ohai (>= 0.6.0)
-      rest-client (>= 1.0.4, < 1.7.0)
-      yajl-ruby (~> 1.1)
-    erubis (2.7.0)
-    highline (1.6.15)
-    ipaddress (0.8.0)
-    json (1.7.7)
-    mime-types (1.21)
-    mixlib-authentication (1.3.0)
-      mixlib-log
-    mixlib-cli (1.3.0)
-    mixlib-config (1.1.2)
-    mixlib-log (1.4.1)
-    mixlib-shellout (1.1.0)
-    net-ssh (2.6.5)
-    net-ssh-gateway (1.2.0)
-      net-ssh (>= 2.6.5)
-    net-ssh-multi (1.1)
-      net-ssh (>= 2.1.4)
-      net-ssh-gateway (>= 0.99.0)
-    ohai (6.16.0)
-      ipaddress
-      mixlib-cli
-      mixlib-config
-      mixlib-log
-      mixlib-shellout
-      systemu
-      yajl-ruby
-    rake (10.0.3)
-    rest-client (1.6.7)
-      mime-types (>= 1.16)
-    systemu (2.5.2)
-    yajl-ruby (1.1.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  knife-cookbook-readme!
-  rake