Skip to content

Commit

Permalink
Updated README structure
Browse files Browse the repository at this point in the history
  • Loading branch information
weavejester committed May 10, 2014
1 parent 4af3e98 commit fbb31d1
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions README.md
@@ -1,25 +1,26 @@
Clout
=====
# Clout

Clout is a library for matching [Ring][1] HTTP requests. It uses the same
routing syntax as used by popular Ruby web frameworks like Ruby on Rails and
Sinatra.

Installation
------------
[1]: https://github.com/ring-clojure/ring

## Installation

Add the following to your project.clj dependencies:

```clj
[clout "1.1.0"]
```

Usage
-----
## Usage

These following examples make use of the [ring-mock][2] library to
generate Ring request maps.

[2]: https://github.com/weavejester/ring-mock

```clj
user=> (use 'ring.mock.request 'clout.core)
nil
Expand Down Expand Up @@ -81,5 +82,9 @@ user=> (route-matches user-route (request :get "/user/jsmith"))
nil
```

[1]: https://github.com/ring-clojure/ring
[2]: https://github.com/weavejester/ring-mock
## License

Copyright © 2014 James Reeves

Distributed under the Eclipse Public License either version 1.0 or (at
your option) any later version.

0 comments on commit fbb31d1

Please sign in to comment.