Readme.md in pelusa-0.0.1 vs Readme.md in pelusa-0.0.2

- old
+ new

@@ -13,15 +13,25 @@ Here's a sample of pelusa linting on its own code base: ![](http://f.cl.ly/items/3Z341M0q2u1K242m0144/%D0%A1%D0%BD%D0%B8%D0%BC%D0%BE%D0%BA%20%D1%8D%D0%BA%D1%80%D0%B0%D0%BD%D0%B0%202012-02-14%20%D0%B2%203.29.38%20PM.png) +## Why Pelusa? + +Pelusa happens to be Spanish for the word "Lint". Yeah, I couldn't believe it +either. + ## Install and usage rvm use rbx-head gem install pelusa +To run pelusa, you must run Rubinius in 1.9 mode. To do this, export this +environment variable: + + export RBXOPT=-X19 + Then go to a directory where you have some Ruby code, and type this: pelusa path/to/some_file.rb Or just run all the Ruby files (`**/*.rb`) without arguments: @@ -30,13 +40,13 @@ ## About the default set of Lints This project was born as an inspiration from [one of our Monday Talks](http://talks.codegram.com/object-oriented-nirvana) about Object Oriented -Nirvana by @oriolgual. After reading [this blog +Nirvana by [@oriolgual](http://twitter.com/oriolgual). After reading [this blog post](http://binstock.blogspot.com/2008/04/perfecting-oos-small-classes-and-short.html) -he prepared his talk and I (Txus) found it interesting, so I explored the +he prepared his talk and I ([@txustice](http://twitter.com/txustice)) found it interesting, so I explored the possibility of programmatically linting these practices on a Ruby project. This *doesn't mean* that any of us thinks these are the true and only practices of Object Orientation, it's just a set of constraints that are fun to follow to achieve a mindset shift in the long run. @@ -49,9 +59,15 @@ default lints under the `lib/pelusa/lint/` directory. At some point it will be user-extendable by default, but for now you are better off forking the project and adding your own lints as you need them in your team (or removing some default ones you don't like). + +## Special mentions + +The beautiful UTF-8 flowers before each lint ran are taken from [Testosterone](http://github.com/masylum/testosterone), +a project by [@masylum](http://twitter.com/masylum). They're really beautiful, +thanks!!! ## Contributing You can easily contribute to Pelusa. Its codebase is simple and [extensively documented][documentation].