diff --git a/README.md b/README.md index 09affde9..35bae12b 100644 --- a/README.md +++ b/README.md @@ -11,8 +11,17 @@ A fast data-driven router for Clojure(Script). * Modular * [Fast](https://metosin.github.io/reitit/performance.html) -The following higher-level routers are also available as separate modules: +Modules: + +* `reitit-core` - the routing core * [`reitit-ring`](https://metosin.github.io/reitit/ring/ring.html) with [data-driven middleware](https://metosin.github.io/reitit/ring/data_driven_middleware.html) +* `reitit-spec` [clojure.spec](https://clojure.org/about/spec) coercion +* `reitit-schema` [Schema](https://github.com/plumatic/schema) coercion +* `reitit-swagger` [Swagger2](https://swagger.io/) apidocs +* `reitit-swagger-ui` Integrated [Swagger UI](https://github.com/swagger-api/swagger-ui). + +Bubblin' under: + * `reitit-http` with enchanced Pedestal-style Interceptors (WIP) * `reitit-frontend` with Keechma-style Controllers (WIP) @@ -33,12 +42,12 @@ All bundled: Optionally, the parts can be required separately: ```clj -[metosin/reitit-core "0.1.1-SNAPSHOT"] ; routing core -[metosin/reitit-ring "0.1.1-SNAPSHOT"] ; ring-router -[metosin/reitit-spec "0.1.1-SNAPSHOT"] ; spec coercion -[metosin/reitit-schema "0.1.1-SNAPSHOT"] ; schema coercion -[metosin/reitit-swagger "0.1.1-SNAPSHOT"] ; swagger -[metosin/reitit-swagger-ui "0.1.1-SNAPSHOT"] ; swagger-ui +[metosin/reitit-core "0.1.1-SNAPSHOT"] +[metosin/reitit-ring "0.1.1-SNAPSHOT"] +[metosin/reitit-spec "0.1.1-SNAPSHOT"] +[metosin/reitit-schema "0.1.1-SNAPSHOT"] +[metosin/reitit-swagger "0.1.1-SNAPSHOT"] +[metosin/reitit-swagger-ui "0.1.1-SNAPSHOT"] ``` ## Quick start diff --git a/doc/README.md b/doc/README.md index e5e05981..6cd36ee0 100644 --- a/doc/README.md +++ b/doc/README.md @@ -11,10 +11,14 @@ * Modular * [Fast](performance.md) -The following higher-level routers are also available as separate modules: -* [`reitit-ring`](./ring/ring.md) with [data-driven middleware](./ring/data_driven_middleware.md) -* `reitit-http` with enchanced Pedestal-style Interceptors (WIP) -* `reitit-frontend` with Keechma-style Controllers (WIP) +Modules: + +* `reitit-core` - the routing core +* [`reitit-ring`](ring/ring.md) with [data-driven middleware](https://metosin.github.io/reitit/ring/data_driven_middleware.html) +* `reitit-spec` [clojure.spec](https://clojure.org/about/spec) coercion +* `reitit-schema` [Schema](https://github.com/plumatic/schema) coercion +* `reitit-swagger` [Swagger2](https://swagger.io/) apidocs +* `reitit-swagger-ui` Integrated [Swagger UI](https://github.com/swagger-api/swagger-ui). To use Reitit, add the following dependecy to your project: @@ -25,12 +29,12 @@ To use Reitit, add the following dependecy to your project: Optionally, the parts can be required separately: ```clj -[metosin/reitit-core "0.1.1-SNAPSHOT"] ; routing core -[metosin/reitit-ring "0.1.1-SNAPSHOT"] ; ring-router -[metosin/reitit-spec "0.1.1-SNAPSHOT"] ; spec coercion -[metosin/reitit-schema "0.1.1-SNAPSHOT"] ; schema coercion -[metosin/reitit-swagger "0.1.1-SNAPSHOT"] ; swagger -[metosin/reitit-swagger-ui "0.1.1-SNAPSHOT"] ; swagger-ui +[metosin/reitit-core "0.1.1-SNAPSHOT"] +[metosin/reitit-ring "0.1.1-SNAPSHOT"] +[metosin/reitit-spec "0.1.1-SNAPSHOT"] +[metosin/reitit-schema "0.1.1-SNAPSHOT"] +[metosin/reitit-swagger "0.1.1-SNAPSHOT"] +[metosin/reitit-swagger-ui "0.1.1-SNAPSHOT"] ``` For discussions, there is a [#reitit](https://clojurians.slack.com/messages/reitit/) channel in [Clojurians slack](http://clojurians.net/).