Add title to generated README and decrease level of headings

mlafeldt · May 15, 2013 · 96ac02a · 96ac02a
1 parent 7140bc1
commit 96ac02a
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 9 deletions.
diff --git a/lib/knife_cookbook_readme/readme_model.rb b/lib/knife_cookbook_readme/readme_model.rb
@@ -7,6 +7,10 @@ def initialize(metadata, constraints=false)
       @constraints = constraints
     end
 
+    def title
+      "#{@metadata.name.capitalize} Cookbook"
+    end
+
     def description
       @metadata.description
     end

diff --git a/template/README.md.erb b/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 %>>)