README.md in raconteur-0.1.0 vs README.md in raconteur-0.1.1
- old
+ new
@@ -26,11 +26,11 @@
@raconteur.parse("Here's what some of our customers are saying about the product:\n{{ customer-quote: id=43 }}\n{{ customer-quote: id=266 }}\n{{ customer-quote: id=7 }}")
# -- outputs --
# Here's what some of our customers are saying:
# <div class="quote" id="customer-quote-43">'The most amazing usability report I have ever read!' - James Newman</div>
# <div class="quote" id="customer-quote-266">'I cannot believe how incredible the benchmark database is!' - Jane Newton</div>
-# <div class="quote" id="customer-quote-7">'Spetacular customer service.' - John Oldling</div>
+# <div class="quote" id="customer-quote-7">'Spectacular customer service.' - John Oldling</div>
```
Here's what's happening in the above example:
- We first create a new instance of Raconteur. (Tip: You can create multiple Raconteur instances, each with its own settings and set of processors.)
@@ -85,10 +85,10 @@
- If you do want to pass in settings to a tag, the tag-name should be followed by a colon and a set of key-value pairs. The key must not include any white-space characters and will be converted to an underscored symbol for the settings hash. The separator should be an equals '=' symbol. The value may either be a word without any white-space characters, or it can be "a text wrapped by quotes". <code>{{ definition: term=UXD + description="User Experience Design (aka UXD + UED + XD) refers to the ..." }}</code>
- To escape quotes within a quoted settings value, put a backslash in front of the quote. You may alternatively configure Raconteur to use a different symbol for wrapping the text. Both non-white-space values and quoted values may be used in the same tag (as seen in the above "User Experience Design" example where the <code>term</code> isn't quoted but the <code>description</code> is). The key-value pairs in settings don't need to be separated by anything other than a white-space character but it can greatly help readability to include some character (such as a '+' symbol, as seen in the above "User Experience Design" example).
## Contributing
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/raconteur.
+Bug reports and pull requests are welcome on GitHub at https://github.com/JamieAppleseed/raconteur.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).