Wrote a README

[alyssais]

I wrote a README for the Sawyer RubyGem.

It's used internally by Octokit, the official GitHub RubyGem, but there is very little information on what Sawyer actually does — in fact, I couldn't really find anything. This made debugging programs using Octokit tricky — it was difficult to work out what all these Sawyer objects were doing. The existing README was… not particularly descriptive, and several other people had also had trouble understanding the project because of this.

So, I dug around in Octokit and Sawyer to figure out what it did and how it worked, and then I wrote a README for it! Here's my initial attempt, and here's the Pull Request I opened for it.

I took inspiration from the default README template that Bundler generates, the Octokit README, and @charlotteis's Open Open Source talk/article.

[PandelisZ]

Oh snap, where there's no doubt that an improvement over what they had

[joenash]

I <3 that you contributed this back. And thanks for such useful links to resources in your issue!

As @PandelisZ said, night and day improvement. It seems a large number of GitHubbers have commit access to this repo, let me see if anyone can merge it.