Permalink
Browse files

Updating docs and gemspec

  • Loading branch information...
1 parent 5c396e4 commit 42fa8922c7df0f4d8c9d03beff562e1be06f477f @MGPalmer MGPalmer committed Feb 2, 2011
Showing with 11 additions and 4 deletions.
  1. +6 −0 README.rdoc
  2. +3 −2 Rakefile
  3. +2 −2 masterplan.gemspec
View
@@ -132,6 +132,8 @@ There is also an added assertion for unit tests or specs:
assert_masterplan(doc, [{:example => :data})
+== Use schemes as examples in documentation
+
A problem with webservices is that you need to keep the documentation up to date - something
that is easily forgotten. If you have a masterplan document, you can use it not only as the template,
but also as an example in, say, online documentation:
@@ -142,6 +144,10 @@ but also as an example in, say, online documentation:
The to_hash method removes the Masterplan::Rule objects for clean output.
+== Caveat
+
+Note that for the moment, schemes, i.e. the outermost object, can only be hashes.
+
== Installation
Currently, you can only install from Github. Add this to your Gemfile:
View
@@ -15,8 +15,9 @@ Jeweler::Tasks.new do |gem|
gem.name = "masterplan"
gem.homepage = "http://github.com/traveliq/masterplan"
gem.license = "MIT"
- gem.summary = %Q{Masterplan is a library for comparing Ruby data structures against predefined templates.}
- gem.description = %Q{Please see the README}
+ summary = %Q{Masterplan is a library for comparing Ruby data structures against predefined templates - like XML Schema without the XML.}
+ gem.summary = summary
+ gem.description = summary + " Please see the README on github for more information."
gem.email = "developer@traveliq.net"
gem.authors = ["Martin Tepper"]
# Include your dependencies below. Runtime dependencies are required when using your gem,
View
@@ -5,11 +5,11 @@
Gem::Specification.new do |s|
s.name = %q{masterplan}
- s.version = "0.2.1"
+ s.version = "0.3.0"
s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
s.authors = ["Martin Tepper"]
- s.date = %q{2011-02-01}
+ s.date = %q{2011-02-02}
s.description = %q{Please see the README}
s.email = %q{developer@traveliq.net}
s.extra_rdoc_files = [

0 comments on commit 42fa892

Please sign in to comment.