Permalink
Newer
100644
49 lines (30 sloc)
1.34 KB
|
f6dcce4
|
||
| 1 | # Ring | |
| 2 | ||
|
e965929
|
||
| 3 | Ring is a Clojure web applications library inspired by Python's WSGI | |
| 4 | and Ruby's Rack. By abstracting the details of HTTP into a simple, | |
| 5 | unified API, Ring allows web applications to be constructed of modular | |
| 6 | components that can be shared among a variety of applications, web | |
| 7 | servers, and web frameworks. | |
|
c1b417e
|
||
| 8 | ||
|
e965929
|
||
| 9 | The [SPEC][1] file at the root of this distribution for provides a | |
| 10 | complete description of the Ring interface. | |
|
c1b417e
|
||
| 11 | ||
|
e965929
|
||
| 12 | [1]: https://github.com/mmcgrana/ring/blob/master/SPEC | |
|
c1b417e
|
||
| 13 | ||
|
e965929
|
||
| 14 | ## Libraries | |
|
c1b417e
|
||
| 15 | ||
|
e965929
|
||
| 16 | * ring-core - essential functions for handling parameters, cookies and more | |
| 17 | * ring-devel - functions for developing and debugging Ring applications | |
| 18 | * ring-servlet - construct Java servlets from Ring handlers | |
| 19 | * ring-jetty-adapter - a Ring adapter that uses the Jetty webserver | |
|
4e630cc
|
||
| 20 | ||
|
e965929
|
||
| 21 | ## Installation | |
|
4e630cc
|
||
| 22 | ||
|
e965929
|
||
| 23 | To include one of the above libraries, for example `ring-core`, add | |
| 24 | the following to your `:dependencies`: | |
|
fd30ea0
|
||
| 25 | ||
|
5727d4d
|
||
| 26 | [ring/ring-core "1.0.2"] | |
|
fd30ea0
|
||
| 27 | ||
|
e965929
|
||
| 28 | To include all of them: | |
|
fd30ea0
|
||
| 29 | ||
|
5727d4d
|
||
| 30 | [ring "1.0.2"] | |
|
c1b417e
|
||
| 31 | ||
|
e965929
|
||
| 32 | ## Documentation | |
|
f6dcce4
|
||
| 33 | ||
|
e965929
|
||
| 34 | * [Wiki](https://github.com/mmcgrana/ring/wiki) | |
|
4c849e6
|
||
| 35 | * [API docs](http://mmcgrana.github.com/ring) | |
| 36 | ||
| 37 | ## Community | |
| 38 | ||
| 39 | * [Google group](http://groups.google.com/group/ring-clojure) | |
|
c1b417e
|
||
| 40 | ||
|
f6dcce4
|
||
| 41 | ## Thanks | |
| 42 | ||
|
e965929
|
||
| 43 | This project borrows heavily from Ruby's Rack and Python's WSGI; | |
| 44 | thanks to those communities for their work. | |
|
fd30ea0
|
||
| 45 | ||
|
f6dcce4
|
||
| 46 | ## License | |
|
c1b417e
|
||
| 47 | ||
|
e965929
|
||
| 48 | Copyright (c) 2009-2012 Mark McGranaghan and released under an MIT license. |