Permalink
Browse files

update README with new instructions; add subproject jar files to giti…

…gnore
  • Loading branch information...
1 parent dbcac6a commit fd30ea0519cb3ff27e306177c2e7be5ddc73241a @sethtrain sethtrain committed with Feb 24, 2010
Showing with 38 additions and 7 deletions.
  1. +1 −0 .gitignore
  2. +37 −7 README.markdown
View
1 .gitignore
@@ -1,5 +1,6 @@
lib
classes
+ring-*.jar
ring.jar
ring-standalone.jar
pom.xml
View
44 README.markdown
@@ -53,27 +53,57 @@ To see a more sophisticated Ring app, run:
Included Libs
-------------
-* `ring.adapter.jetty`: Adapter for the Jetty webserver.
-* `ring.adapter.httpcore`: Adapter for the Apache HttpCore webserver.
+* `ring.example.*`: Various example Ring apps.
+
+### ring-core
+
* `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-devel
+
+* `ring.handler.dump`: Handler that dumps request maps as HTML responses for debugging.
* `ring.middleware.lint`: Linter for the Ring interface, ensures compliance with the Ring spec.
* `ring.middleware.reload`: Middleware to automatically reload selected libs before each requests, minimizing server restarts.
* `ring.middleware.stacktrace`: Middleware that catches exceptions and displays readable stacktraces for debugging.
-* `ring.middleware.static`: Middleware that serves static files with specified prefixes out of a public directory.
-* `ring.handler.dump`: Handler that dumps request maps as HTML responses for debugging.
+
+### ring-httpcore-adapter
+
+* `ring.adapter.httpcore`: Adapter for the Apache HttpCore webserver.
+
+### ring-servlet
+
* `ring.util.servlet`: Utilities for interfacing with Java Servlets.
-* `ring.example.*`: Various example Ring apps.
+
+### ring-jetty-adapter
+
+* `ring.adapter.jetty`: Adapter for the Jetty webserver.
+
+Lein project usage
+------------------
+
+To include one of the above libraries in your leiningen project:
+
+ [ring/*lib-name* "0.2.0-SNAPSHOT"]
+
+or
+
+ [ring "0.2.0-SNAPSHOT"]
+
+for the "all in one" solution.
Development
-----------
Ring is being actively developed; you can track its progress and contribute at the project's [GitHub page](http://github.com/mmcgrana/ring) and [Google Group](http://groups.google.com/group/ring-clojure).
-To run all the Ring unit tests:
+To run the Ring unit tests navigate to the individual project and run:
$ lein test
+This assumes `lein deps` has been run.
+
Thanks
------
@@ -84,4 +114,4 @@ License
Copyright (c) 2009-2010 Mark McGranaghan and released under an MIT license.
-Clojure logo by Tom Hickey.
+Clojure logo by Tom Hickey.

0 comments on commit fd30ea0

Please sign in to comment.