Skip to content

Commit

Permalink
tmp
Browse files Browse the repository at this point in the history
  • Loading branch information
weavejester committed Nov 6, 2023
1 parent 20584af commit 28a66ac
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 167 deletions.
53 changes: 27 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,40 +8,45 @@ 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
The [SPEC.md][1] file at the root of this distribution provides a
complete description of the Ring interface.

[1]: https://github.com/ring-clojure/ring/blob/master/SPEC
[1]: https://github.com/ring-clojure/ring/blob/master/SPEC.md

## Upgrade Notice
## Libraries

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]).
* `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 Java Servlets (≤ 4.0) from Ring
handlers
* `org.ring-clojure/ring-jakarta-servlet` construct
[Jakarta Servlets][2] (≥ 5.0) from Ring handlers
* `ring/ring-jetty-adapter` - a Ring adapter that uses an embedded
[Jetty][2] web server

[2]: https://projects.eclipse.org/projects/ee4j.servlet
[3]: https://eclipse.dev/jetty/

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:
## Installation

[javax.servlet/servlet-api "2.5"]
To include one of the above libraries, for instance `ring-core`, add
the following dependency to your `deps.edn` file:

[2]: https://github.com/ring-clojure/ring/pull/89
ring/ring-core {:mvn/version "1.10.0"}

## Libraries
Or to your Leiningen project file:

* 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

## Installation
[ring/ring-core "1.10.0"]

To include one of the above libraries, for example `ring-core`, add
the following to your `:dependencies`:
To include all Ring libraries, you can use the `ring` meta-package:

[ring/ring-core "1.10.0"]
ring/ring {:mvn/version "1.10.0"}

To include all of them:
Or for Leiningen:

[ring "1.10.0"]

Expand All @@ -50,10 +55,6 @@ To include all of them:
* [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].
Expand Down
141 changes: 0 additions & 141 deletions SPEC

This file was deleted.

File renamed without changes.

0 comments on commit 28a66ac

Please sign in to comment.