Skip to content

Commit

Permalink
Update README information
Browse files Browse the repository at this point in the history
  • Loading branch information
weavejester committed Nov 6, 2023
1 parent 8cad5a1 commit 82f4d27
Showing 1 changed file with 32 additions and 36 deletions.
68 changes: 32 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,69 +1,65 @@
# Ring

[![Build Status](https://github.com/ring-clojure/ring/actions/workflows/test.yml/badge.svg)](https://github.com/ring-clojure/ring/actions/workflows/test.yml)
# Ring [![Build Status](https://github.com/ring-clojure/ring/actions/workflows/test.yml/badge.svg)](https://github.com/ring-clojure/ring/actions/workflows/test.yml)

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][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

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

[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.ring-clojure/ring-websocket-protocols` - contains only the protocols
necessary for WebSockets
* `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

This project borrows heavily from Ruby's Rack and Python's WSGI;
thanks to those communities for their work.
thanks to those communities for their work. Thanks also go to the many
individuals who have contributed to Ring's code and documentation over
the years.

## License

Expand Down

0 comments on commit 82f4d27

Please sign in to comment.