README.rdoc in monocle-0.1.0 vs README.rdoc in monocle-0.1.1
- old
+ new
@@ -1,7 +1,30 @@
= monocle
-Description goes here.
+Gemfile
+
+ gem "monocle"
+
+Routes file
+
+ mount Monocle::Server.new, :at => "/monocle"
+
+Your server config
+
+ location /monocle/ {
+ if ($request_method = GET) {
+ rewrite ^(/monocle/.*) /images/transparent.gif last;
+ }
+
+ if ($request_method = POST) {
+ proxy_pass http://application;
+ rewrite ^(/monocle/.*) $1 break;
+ }
+ }
+
+Javascript in your views
+
+ $.post("/monocle/my_object_type/my_object_id.gif");
== Contributing to monocle
* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it