Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

REDAME rdoc -> markdown

  • Loading branch information...
commit ec1b0d71b89ecbca252d609c25c2542cba63c4dd 1 parent ebb2ff1
Thibaud Guillaume-Gentil authored
Showing with 24 additions and 14 deletions.
  1. +1 −1  LICENSE
  2. +23 −13 README.rdoc → README.markdown
View
2  LICENSE
@@ -1,4 +1,4 @@
-Copyright (c) 2010 Thibaud Guillaume-Gentil
+Copyright (c) 2011 Thibaud Guillaume-Gentil
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
View
36 README.rdoc → README.markdown
@@ -1,32 +1,42 @@
-= Rack::Private
+Rack::Private
+=============
-Private Rack middleware purpose is to protect your Rack application from anonymous via a secret code form.
+> Private Rack middleware purpose is to protect your Rack application from anonymous via a secret code form.
-== Installation
+Installation
+------------
- gem install rack-private
+ gem install rack-private
-== Usage
+Usage
+-----
+
+``` ruby
+require 'rack-private'
+use Rack::Private :code => 'secret'
+```
- require 'rack-private'
- use Rack::Private :code => 'secret'
-
You can also define multiple codes.
- use Rack::Private :codes => ['secret', 'super-secret']
-
+``` ruby
+use Rack::Private :codes => ['secret', 'super-secret']
+```
+
And provide your own template.
- use Rack::Private :code => 'secret', :template_path => Rails.root.join("app/templates/private.html")
+``` ruby
+use Rack::Private :code => 'secret', :template_path => Rails.root.join("app/templates/private.html")
+```
== Note on Patches/Pull Requests
-
+
* Fork the project.
* Make your feature addition or bug fix.
* Add tests for it. This is important so I don't break it in a future version unintentionally.
* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
* Send me a pull request. Bonus points for topic branches.
-== Contributors
+Author
+------
* {Thibaud Guillaume-Gentil}[http://github.com/thibaudgg]
Please sign in to comment.
Something went wrong with that request. Please try again.