luciano/reitit
1
0
Fork 0
mirror of https://github.com/metosin/reitit.git synced 2025-12-18 08:51:12 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs

Browse source
This commit is contained in:
Tommi Reiman 2018-08-05 17:32:57 +03:00
parent d13dab9e32
commit 8603224546
5 changed files with 36 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -44,11 +44,24 @@ Optionally, the parts can be required separately:
```clj ```clj
[metosin/reitit-core "0.2.0-SNAPSHOT"] [metosin/reitit-core "0.2.0-SNAPSHOT"]
[metosin/reitit-ring "0.2.0-SNAPSHOT"]
;; coercion
[metosin/reitit-spec "0.2.0-SNAPSHOT"] [metosin/reitit-spec "0.2.0-SNAPSHOT"]
[metosin/reitit-schema "0.2.0-SNAPSHOT"] [metosin/reitit-schema "0.2.0-SNAPSHOT"]
;; ring helpers
[metosin/reitit-ring "0.2.0-SNAPSHOT"]
[metosin/reitit-middleware "0.2.0-SNAPSHOT"]
;; swagger-support for ring & http
[metosin/reitit-swagger "0.2.0-SNAPSHOT"] [metosin/reitit-swagger "0.2.0-SNAPSHOT"]
[metosin/reitit-swagger-ui "0.2.0-SNAPSHOT"] [metosin/reitit-swagger-ui "0.2.0-SNAPSHOT"]
;; frontend helpers (alpha)
[metosin/reitit-frontend "0.2.0-SNAPSHOT"]
;; http helpers (alpha)
[metosin/reitit-http "0.2.0-SNAPSHOT"]
``` ```
## Quick start ## Quick start

16
doc/README.md
View file

@ -31,12 +31,24 @@ Optionally, the parts can be required separately:
```clj ```clj
[metosin/reitit-core "0.2.0-SNAPSHOT"] [metosin/reitit-core "0.2.0-SNAPSHOT"]
[metosin/reitit-ring "0.2.0-SNAPSHOT"]
;; coercion
[metosin/reitit-spec "0.2.0-SNAPSHOT"] [metosin/reitit-spec "0.2.0-SNAPSHOT"]
[metosin/reitit-schema "0.2.0-SNAPSHOT"] [metosin/reitit-schema "0.2.0-SNAPSHOT"]
;; ring helpers
[metosin/reitit-ring "0.2.0-SNAPSHOT"]
[metosin/reitit-middleware "0.2.0-SNAPSHOT"]
;; swagger-support for ring & http
[metosin/reitit-swagger "0.2.0-SNAPSHOT"] [metosin/reitit-swagger "0.2.0-SNAPSHOT"]
[metosin/reitit-swagger-ui "0.2.0-SNAPSHOT"] [metosin/reitit-swagger-ui "0.2.0-SNAPSHOT"]
[metosin/frontend "0.1.4-SNAPSHOT"]
;; frontend helpers (alpha)
[metosin/reitit-frontend "0.2.0-SNAPSHOT"]
;; http helpers (alpha)
[metosin/reitit-http "0.2.0-SNAPSHOT"]
``` ```
For discussions, there is a [#reitit](https://clojurians.slack.com/messages/reitit/) channel in [Clojurians slack](http://clojurians.net/). For discussions, there is a [#reitit](https://clojurians.slack.com/messages/reitit/) channel in [Clojurians slack](http://clojurians.net/).

5
modules/reitit/project.clj
View file

@ -7,10 +7,11 @@
:parent-project {:path "../../project.clj" :parent-project {:path "../../project.clj"
:inherit [:deploy-repositories :managed-dependencies]} :inherit [:deploy-repositories :managed-dependencies]}
:dependencies [[metosin/reitit-core] :dependencies [[metosin/reitit-core]
[metosin/reitit-ring]
[metosin/reitit-middleware]
[metosin/reitit-spec] [metosin/reitit-spec]
[metosin/reitit-schema] [metosin/reitit-schema]
[metosin/reitit-ring]
[metosin/reitit-middleware]
[metosin/reitit-http]
[metosin/reitit-swagger] [metosin/reitit-swagger]
[metosin/reitit-swagger-ui] [metosin/reitit-swagger-ui]
[metosin/reitit-frontend]]) [metosin/reitit-frontend]])

6
project.clj
View file

@ -11,10 +11,11 @@
:managed-dependencies [[metosin/reitit "0.2.0-SNAPSHOT"] :managed-dependencies [[metosin/reitit "0.2.0-SNAPSHOT"]
[metosin/reitit-core "0.2.0-SNAPSHOT"] [metosin/reitit-core "0.2.0-SNAPSHOT"]
[metosin/reitit-ring "0.2.0-SNAPSHOT"]
[metosin/reitit-middleware "0.2.0-SNAPSHOT"]
[metosin/reitit-spec "0.2.0-SNAPSHOT"] [metosin/reitit-spec "0.2.0-SNAPSHOT"]
[metosin/reitit-schema "0.2.0-SNAPSHOT"] [metosin/reitit-schema "0.2.0-SNAPSHOT"]
[metosin/reitit-ring "0.2.0-SNAPSHOT"]
[metosin/reitit-middleware "0.2.0-SNAPSHOT"]
[metosin/reitit-http "0.2.0-SNAPSHOT"]
[metosin/reitit-swagger "0.2.0-SNAPSHOT"] [metosin/reitit-swagger "0.2.0-SNAPSHOT"]
[metosin/reitit-swagger-ui "0.2.0-SNAPSHOT"] [metosin/reitit-swagger-ui "0.2.0-SNAPSHOT"]
[metosin/reitit-frontend "0.2.0-SNAPSHOT"] [metosin/reitit-frontend "0.2.0-SNAPSHOT"]
@ -39,6 +40,7 @@
:source-paths ["modules/reitit/src" :source-paths ["modules/reitit/src"
"modules/reitit-core/src" "modules/reitit-core/src"
"modules/reitit-ring/src" "modules/reitit-ring/src"
"modules/reitit-http/src"
"modules/reitit-middleware/src" "modules/reitit-middleware/src"
"modules/reitit-spec/src" "modules/reitit-spec/src"
"modules/reitit-schema/src" "modules/reitit-schema/src"

2
scripts/lein-modules
View file

@ -3,6 +3,6 @@
set -e set -e
# Modules # Modules
for ext in reitit-core reitit-ring reitit-middleware reitit-spec reitit-schema reitit-swagger reitit-swagger-ui reitit-frontend reitit; do for ext in reitit-core reitit-spec reitit-schema reitit-ring reitit-middleware reitit-http reitit-swagger reitit-swagger-ui reitit-frontend reitit; do
cd modules/$ext; lein "$@"; cd ../..; cd modules/$ext; lein "$@"; cd ../..;
done done