README.md in octopress-codefence-1.2.1 vs README.md in octopress-codefence-1.3.0

- old
+ new

@@ -1,11 +1,10 @@ # Octopress Codefence Write beautiful fenced code snippets within any template. -[![Build -Status](https://travis-ci.org/octopress/octopress-codefence.png?branch=master)](https://travis-ci.org/octopress/octopress-codefence) +[![Build Status](https://travis-ci.org/octopress/octopress-codefence.png?branch=master)](https://travis-ci.org/octopress/octopress-codefence) ## Installation Add this line to your application's Gemfile: @@ -19,14 +18,81 @@ $ gem install octopress-codefence ## Usage -TODO: Write usage instructions here +First, add the gem to your Jekyll configuration. +```yaml +gems: + - octopress-codefence +``` + +Next, add the Octopress stlyesheets tag to your site layout this will inject stylesheet tags for all Octopress Ink plugins. + +```html +<!--Somewhere in your site's head--> +{% octopress_css %} +``` + +Finally, give it a try. + + ```ruby mark:2-4 title:"Testing codefence" url:"https://github.com/octopress/codefence" link_text:"plugin link" + class Float + def number_decimal_places + self.to_s.length-2 + end + + def to_fraction + higher = 10**self.number_decimal_places + lower = self*higher + + gcden = greatest_common_divisor(higher, lower) + + return (lower/gcden).round, (higher/gcden).round + end + + private + + def greatest_common_divisor(a, b) + while a%b != 0 + a,b = b.round,(a%b).round + end + return b + end + end + ``` + +More documentation coming soon. + ## Contributing 1. Fork it 2. Create your feature branch (`git checkout -b my-new-feature`) 3. Commit your changes (`git commit -am 'Add some feature'`) 4. Push to the branch (`git push origin my-new-feature`) 5. Create new Pull Request + +## License MIT + +Copyright (c) 2013 Brandon Mathis + +MIT License + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.