README.md in footing-0.0.2 vs README.md in footing-0.0.3
- old
+ new
@@ -1,12 +1,12 @@
# Footing
-#### NOTE: this lib is experimental at the moment
-
Footing provides some sanity for monkey patching practices.
It's also a utility lib that contains additional functionality for core objects that you might find useful.
+#### NOTE: this lib is experimental at the moment
+
## No implicit monkey patching
**No surprises here.** You must explicitly patch.
```ruby
@@ -57,12 +57,21 @@
```ruby
Footing.patch_all!
```
+## Patch free
+
+Dont like monkey patches? Run patch free by setting up utility methods instead.
+
+```ruby
+Footing.util! Footing::String
+Footing::String.escape "foo", "o" # => "f\\o\\o"
+```
+
## Kick the tires
* `git clone git://github.com/hopsoft/footing.git`
* `cd /path/to/footing`
* `bundle`
* `./console`
-* `Footing.patch String, Footing::String`
+* `Footing.patch! String, Footing::String`