Permalink
Browse files

Fix Readme formatting.

  • Loading branch information...
mmcgrana committed Jul 12, 2009
1 parent cbeebac commit e6abe13fc587284d93bdb8d172ecf6fdac669f75
Showing with 15 additions and 35 deletions.
  1. +15 −35 README.textile
View
@@ -1,12 +1,8 @@
h1. Ring
-Ring is a Clojure web applications library inspired by Python's WSGI and Ruby's
-Rack. By abstracting the details of HTTP into a simple, unified API, Ring allows
-web applications to be constructed of modular components that can be shared among
-a variety of applications, web servers, and web frameworks.
+Ring is a Clojure web applications library inspired by Python's WSGI and Ruby's Rack. By abstracting the details of HTTP into a simple, unified API, Ring allows web applications to be constructed of modular components that can be shared among a variety of applications, web servers, and web frameworks.
-The @SPEC@ file at the root of this distribution for provides a complete
-description of the Ring interface.
+The @SPEC@ file at the root of this distribution for provides a complete description of the Ring interface.
h2. Quick Start
@@ -20,49 +16,33 @@ To see a live "Hello World" Ring app, run:
java -Djava.ext.dirs=deps clojure.main src/ring/examples/hello_world.clj
-Now visit @http://localhost:8080/@ in your browser; the Ring app will respond
-to your request with a simple HTML page indicating the time of day.
+Now visit @http://localhost:8080/@ in your browser; the Ring app will respond to your request with a simple HTML page indicating the time of day.
To see a more sophisticated Ring app, run:
java -Djava.ext.dirs=deps clojure.main src/ring/example/wrapping.clj
- * If you request @http://localhost:8080/@ in your browser the @ring.dump@
- handler will respond with an HTML page representing the request map that it
- received (see the @SPEC@ for details on the request map).
- * If you request @http://localhost:8080/clojure.png@, the @ring.file@
- middleware will detect that there is a @clojure.png@ file in the app's
- @public@ directory and return that image as a response.
- * If you request @http://localhost:8080/error@, the app will produce an error
- that will be caught by the @ring.show-exceptions@ middleware, which will in
- turn return a readable stacktrace as the HTML response.
+ * If you request @http://localhost:8080/@ in your browser the @ring.dump@ handler will respond with an HTML page representing the request map that it received (see the @SPEC@ for details on the request map).
+ * If you request @http://localhost:8080/clojure.png@, the @ring.file@ middleware will detect that there is a @clojure.png@ file in the app's @public@ directory and return that image as a response.
+ * If you request @http://localhost:8080/error@, the app will produce an error that will be caught by the @ring.show-exceptions@ middleware, which will in turn return a readable stacktrace as the HTML response.
h2. Included Libs
* @ring.adapter.jetty@: Adapter for the Jetty webserver.
* @ring.adapter.httpcore@: Adapter for the Apache HttpCore webserver.
- * @ring.middleware.file@: Middleware that serves static files out of a public
- directory.
- * @ring.middleware.file-info@: Middleware that augments response headers with
- info about File responses.
- * @ring.middleware.static@: Middleware that serves static files with specified
- prefixes out of a public directory.
- * @ring.middleware.show-exceptions@: Middleware that catches exceptions and
- displays readable stacktraces for debugging.
- * @ring.middleware.reload@: Middleware to automatically reload selected libs
- before each requests, minimizing server restarts.
- * @ring.handler.dump@: Handler that dumps request maps as HTML responses for
- debugging.
- * @ring.util.builder@: Helpers for composing Ring apps from multiple handlers
- and middleware.
- * @ring.util.lint@: Linter for the Ring interface, ensures compliance with the
- Ring spec.
+ * @ring.middleware.file@: Middleware that serves static files out of a public directory.
+ * @ring.middleware.file-info@: Middleware that augments response headers with info about File responses.
+ * @ring.middleware.static@: Middleware that serves static files with specified prefixes out of a public directory.
+ * @ring.middleware.show-exceptions@: Middleware that catches exceptions and displays readable stacktraces for debugging.
+ * @ring.middleware.reload@: Middleware to automatically reload selected libs before each requests, minimizing server restarts.
+ * @ring.handler.dump@: Handler that dumps request maps as HTML responses for debugging.
+ * @ring.util.builder@: Helpers for composing Ring apps from multiple handlers and middleware.
+ * @ring.util.lint@: Linter for the Ring interface, ensures compliance with the Ring spec.
* @ring.example.*@: Various example Ring apps.
h2. Development
-Ring is being actively developed; you can track its progress and contribute at
-the project's "GitHub"::http://github.com/mmcgrana/ring page.
+Ring is being actively developed; you can track its progress and contribute at the project's "GitHub"::http://github.com/mmcgrana/ring page.
To run all the Ring unit tests:

0 comments on commit e6abe13

Please sign in to comment.