tmp

README.md

@@ -8,57 +8,53 @@ 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][1] file at the root of this distribution provides a
-complete description of the Ring interface.
+The [SPEC.md][1] file at the root of this distribution provides a
+complete description of the Ring interface. The [Wiki][2] contains
+more in-depth documentation on how to use Ring.
 
-[1]: https://github.com/ring-clojure/ring/blob/master/SPEC
-
-## Upgrade Notice
-
-From version 1.2.1 onward, the ring/ring-core package no longer comes
-with the `javax.servlet/servlet-api` package as a dependency (see
-issue [#89][2]).
-
-If you are using the `ring/ring-core` namespace on its own, you may
-run into errors when executing tests or running alternative adapters.
-To resolve this, include the following dependency in your dev profile:
-
-    [javax.servlet/servlet-api "2.5"]
-
-[2]: https://github.com/ring-clojure/ring/pull/89
+[1]: https://github.com/ring-clojure/ring/blob/master/SPEC.md
+[2]: https://github.com/ring-clojure/ring/wiki
 
 ## Libraries
 
-* ring-core - essential functions for handling parameters, cookies and more
-* ring-devel - functions for developing and debugging Ring applications
-* ring-servlet - construct Java servlets from Ring handlers
-* ring-jetty-adapter - a Ring adapter that uses the Jetty webserver
+* `ring/ring` - meta-package containing all relevant dependencies
+* `ring/ring-core` - core functions and middleware for Ring handlers,
+  requests and responses
+* `org.clojure/ring-websocket-protocols` - contains only the protocols
+  necessary for the WebSocket API
+* `ring/ring-devel` - functions for developing and debugging Ring
+  applications
+* `ring/ring-servlet` - construct legacy Java Servlets (≤ 4.0) from Ring
+  handlers
+* `org.ring-clojure/ring-jakarta-servlet` construct
+  [Jakarta Servlets][3] (≥ 5.0) from Ring handlers
+* `ring/ring-jetty-adapter` - a Ring adapter that uses an embedded
+  [Jetty][4] web server
+
+[3]: https://projects.eclipse.org/projects/ee4j.servlet
+[4]: https://eclipse.dev/jetty/
 
 ## Installation
 
-To include one of the above libraries, for example `ring-core`, add
-the following to your `:dependencies`:
+To include one of the above libraries, for instance `ring-core`, add
+the following dependency to your `deps.edn` file:
 
-    [ring/ring-core "1.10.0"]
+    ring/ring-core {:mvn/version "1.10.0"}
 
-To include all of them:
+Or to your Leiningen project file:
 
-    [ring "1.10.0"]
+    [ring/ring-core "1.10.0"]
 
 ## Documentation
 
 * [Wiki](https://github.com/ring-clojure/ring/wiki)
 * [API docs](https://ring-clojure.github.io/ring/)
 
-## Community
-
-* [Google group](http://groups.google.com/group/ring-clojure)
-
 ## Contributing
 
-Please see [CONTRIBUTING.md][3].
+Please read [CONTRIBUTING.md][5] before submitting a pull request.
 
-[3]: https://github.com/ring-clojure/ring/blob/master/CONTRIBUTING.md
+[5]: https://github.com/ring-clojure/ring/blob/master/CONTRIBUTING.md
 
 ## Thanks