README.md in render_cow-0.3.0 vs README.md in render_cow-0.4.0
- old
+ new
@@ -1,23 +1,28 @@
- _____
-| RenderCow |
- -----
+```bash
+ ______________________
+| RenderCow! |
+ ----------------------
\ ^__^
\ (oo)\_______
(__)\ )\/\
||----w |
|| ||
+```
RenderCow cowpatches the Rails render method to allow you to directly use cowsay.
Have you ever wanted to just render a cow?
Well now you can!
+[See RenderCow in Action!](https://wasurechatta.com/moo?moo=RenderCow%20in%20action!)
## Usage
In your controller, replace calls with `render plain:` to `render cowsay:` or `render cow:`.
+(You can still use render plain: and render partial: and others too, but you get invested cow superpowers by this gem)
+
```ruby
class ApplicationController < ActionController::Base
def index
render cowsay: "Moo"
end
@@ -26,10 +31,22 @@
render cow: "Mooo"
end
end
```
+But that is not all!
+You also have the following render-options:
+```ruby
+[:spongebob, :beavis, :bunny, :cheese, :cow, :daemon, :dragon, :elephant, :frogs, :ghostbusters, :kitty, :koala, :moose, :ren, :sheep, :stegosaurus, :stimpy, :turkey, :turtle, :tux]
+```
+
+So feel free to call `render spongebob: iS thIs A mEme?` from your controllers!
+
+Todo:
+Make Spongebob do the meme talk automatically.
+There is already a gem for that.
+
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'render_cow'
@@ -42,9 +59,12 @@
Or install it yourself as:
```bash
$ gem install render_cow
```
+
+This gem uses [cowsay](https://rubygems.org/gems/cowsay) as the cow rendering engine.
+So this gem is just the Rails cow patch on the render method.
## Contributing
Feel free to contribute.
## License