Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Tying up loose ends in the README.

  • Loading branch information...
commit 0a7f7e898cc31f22828e8212e12e9aa37ab0f9ac 1 parent 9bcb351
@mwunsch authored
Showing with 5 additions and 8 deletions.
  1. +5 −8 README.md
View
13 README.md
@@ -1,7 +1,5 @@
# Weary
-This is the **big rewrite** of Weary, currently ongoing.
-
_Weary is a framework and DSL for building clients for (preferably RESTful) web service APIs._
At its most minimal, Weary is simply some nice syntactic sugar around Net/HTTP.
@@ -18,6 +16,7 @@ It features:
`Weary::Request#perform`, the thing that performs the request, returns a [future](http://en.wikipedia.org/wiki/Futures_and_promises) and only blocks when accessed.
+It takes its inspiration from [HTTParty](https://github.com/jnunemaker/httparty) and [Faraday](https://github.com/technoweenie/faraday).
## Quick Start
@@ -132,15 +131,13 @@ Authentication, by default is done by either `Weary::Middleware::BasicAuth` or `
The point is, **it's just Rack**.
-## TODO
-
-1. More documentation.
+## Release Candidate
-2. I'm not particularly happy about the specs, they seem a bit brittle in places.
+At this point, I need _your_ help to further Weary along. I'd love to see more examples that utilize the Rackness of Weary: using Devise, Warden, or mounted in a Rails application.
-3. I'd love to see more examples that utilize the Rackness of Weary. Using Devise, Warden, or mounted in a Rails application.
+## Examples
-4. Need to push adapter and middleware onto the Resource for Weary::Route's benefit.
+[**Gilt**](https://github.com/mwunsch/gilt) is a Ruby client to the [Gilt public API](https://dev.gilt.com/). Notice how much of the code is dedicated to the Gilt domain model, and very little to actually interacting with the web service. That's the idea.
## Copyright
Please sign in to comment.
Something went wrong with that request. Please try again.