Permalink
Browse files

README

  • Loading branch information...
1 parent 1f54d1c commit 396b058bb9bf6eff7bd3b84e81a62747225dbcff @benbjohnson committed Jan 27, 2011
Showing with 47 additions and 0 deletions.
  1. +47 −0 README.md
View
@@ -0,0 +1,47 @@
+Slow Web - A Request Governor
+=============================
+
+## DESCRIPTION
+
+Slow Web is a way to limit the number of requests to a domain within a certain
+period of time.
+
+For example, the GitHub API only allows for 60 requests per minute. Slow Web can
+monitor the number of calls to that domain and will sleep on the next request
+that is over the limit.
+
+Slow Web follows the rules of [Semantic Versioning](http://semver.org/).
+
+
+## RUNNING
+
+To install Slow Web, simply install the gem:
+
+ $ [sudo] gem install slowweb
+
+And specify the domain to limit.
+
+ require 'slowweb'
+ SlowWeb.limit('github.com', 60, 3600)
+
+This restricts the `github.com` domain to only allowing `60` requests every
+`3600` seconds (or one hour).
+
+
+## CONTRIBUTE
+
+If you'd like to contribute to SlowWeb, start by forking the repository
+on GitHub:
+
+http://github.com/benbjohnson/slowweb
+
+Then follow these steps to send your changes:
+
+1. Clone down your fork
+1. Create a topic branch to contain your change
+1. Code
+1. All code must have MiniTest::Unit test coverage.
+1. If you are adding new functionality, document it in the README
+1. If necessary, rebase your commits into logical chunks, without errors
+1. Push the branch up to GitHub
+1. Send me a pull request for your branch

0 comments on commit 396b058

Please sign in to comment.