reitit/README.md

# reitit [![Build Status](https://travis-ci.org/metosin/reitit.svg?branch=master)](https://travis-ci.org/metosin/reitit) [![Dependencies Status](https://jarkeeper.com/metosin/reitit/status.svg)](https://jarkeeper.com/metosin/reitit)

A friendly data-driven router for Clojure(Script).

* Simple data-driven [route syntax](https://metosin.github.io/reitit/basics.html#route-syntax)
* First-class [route meta-data](https://metosin.github.io/reitit/basics.html#route-data)
* Generic, not tied to HTTP
* [Route conflict resolution](https://metosin.github.io/reitit/route_conflicts.html)
* [Pluggable coercion](https://metosin.github.io/reitit/parameter_coercion.html) ([clojure.spec](https://clojure.org/about/spec))
* both [Middleware](https://metosin.github.io/reitit/compiling_middleware.html) & Interceptors
* Extendable
* Fast

Ships with example router for [Ring](#ring). See [Issues](https://github.com/metosin/reitit/issues) for roadmap.

## Latest version

[![Clojars Project](http://clojars.org/metosin/reitit/latest-version.svg)](http://clojars.org/metosin/reitit)

## Documentation

[Check out the full documentation!](https://metosin.github.io/reitit/)

## Special thanks

To all Clojure(Script) routing libs out there, expecially to
[Ataraxy](https://github.com/weavejester/ataraxy), [Bide](https://github.com/funcool/bide), [Bidi](https://github.com/juxt/bidi), [Compojure](https://github.com/weavejester/compojure) and
[Pedestal](https://github.com/pedestal/pedestal/tree/master/route).

Also to [Compojure-api](https://github.com/metosin/compojure-api), [Kekkonen](https://github.com/metosin/kekkonen) and [Ring-swagger](https://github.com/metosin/ring-swagger) and  for the data-driven syntax, coercion & stuff.

And some [Yada](https://github.com/juxt/yada) too.

## Development instructions

The documentation is built with [gitbook](https://toolchain.gitbook.com). To preview your changes locally:

```bash
npm install -g gitbook-cli
gitbook install
gitbook serve
```

## License

Copyright © 2017 [Metosin Oy](http://www.metosin.fi)

Distributed under the Eclipse Public License, the same as Clojure.
Initial commit 2017-08-07 11:08:39 +00:00			`# reitit [![Build Status](https://travis-ci.org/metosin/reitit.svg?branch=master)](https://travis-ci.org/metosin/reitit) [![Dependencies Status](https://jarkeeper.com/metosin/reitit/status.svg)](https://jarkeeper.com/metosin/reitit)`

Update README, fix NPE with match-by-name 2017-08-17 05:54:54 +00:00			`A friendly data-driven router for Clojure(Script).`
Initial commit 2017-08-07 11:08:39 +00:00
Fix readme doc links 2017-10-25 14:09:25 +00:00			`* Simple data-driven [route syntax](https://metosin.github.io/reitit/basics.html#route-syntax)`
			`* First-class [route meta-data](https://metosin.github.io/reitit/basics.html#route-data)`
Add stuff * router, partially from Pedestal * sample perf tests * kws expand to :name * fns expand to :handler 2017-08-08 12:31:00 +00:00			`* Generic, not tied to HTTP`
Fix readme doc links 2017-10-25 14:09:25 +00:00			`* [Route conflict resolution](https://metosin.github.io/reitit/route_conflicts.html)`
Fix doc links 2017-10-25 14:37:12 +00:00			`* [Pluggable coercion](https://metosin.github.io/reitit/parameter_coercion.html) ([clojure.spec](https://clojure.org/about/spec))`
Fix readme doc links 2017-10-25 14:09:25 +00:00			`* both [Middleware](https://metosin.github.io/reitit/compiling_middleware.html) & Interceptors`
Add stuff * router, partially from Pedestal * sample perf tests * kws expand to :name * fns expand to :handler 2017-08-08 12:31:00 +00:00			`* Extendable`
			`* Fast`

Update README 2017-08-17 06:24:23 +00:00			`Ships with example router for [Ring](#ring). See [Issues](https://github.com/metosin/reitit/issues) for roadmap.`

Initial commit 2017-08-07 11:08:39 +00:00			`## Latest version`

			`[![Clojars Project](http://clojars.org/metosin/reitit/latest-version.svg)](http://clojars.org/metosin/reitit)`

Move documentation to GitBook 2017-09-14 13:33:36 +00:00			`## Documentation`
Initial commit 2017-08-07 11:08:39 +00:00
Move documentation to GitBook 2017-09-14 13:33:36 +00:00			`[Check out the full documentation!](https://metosin.github.io/reitit/)`
Update README, more perf-tests, cleanup * `match` => `match-by-path` * `by-name` = > `match-by-name` * `lookup-router` can't be created with wildcard routes * `match-by-name` initial perf tests 2017-08-11 04:48:55 +00:00
Add stuff * router, partially from Pedestal * sample perf tests * kws expand to :name * fns expand to :handler 2017-08-08 12:31:00 +00:00			`## Special thanks`

			`To all Clojure(Script) routing libs out there, expecially to`
			`[Ataraxy](https://github.com/weavejester/ataraxy), [Bide](https://github.com/funcool/bide), [Bidi](https://github.com/juxt/bidi), [Compojure](https://github.com/weavejester/compojure) and`
Fix README 2017-08-09 07:36:57 +00:00			`[Pedestal](https://github.com/pedestal/pedestal/tree/master/route).`
Initial commit 2017-08-07 11:08:39 +00:00
Update README 2017-09-08 05:29:39 +00:00			`Also to [Compojure-api](https://github.com/metosin/compojure-api), [Kekkonen](https://github.com/metosin/kekkonen) and [Ring-swagger](https://github.com/metosin/ring-swagger) and for the data-driven syntax, coercion & stuff.`

			`And some [Yada](https://github.com/juxt/yada) too.`

README.md: Instructions for running gitbook locally 2017-09-14 13:58:39 +00:00			`## Development instructions`

			`The documentation is built with [gitbook](https://toolchain.gitbook.com). To preview your changes locally:`

			```bash
			`npm install -g gitbook-cli`
Instal gitbook modules 2017-09-18 04:36:02 +00:00			`gitbook install`
README.md: Instructions for running gitbook locally 2017-09-14 13:58:39 +00:00			`gitbook serve`
			```

Initial commit 2017-08-07 11:08:39 +00:00			`## License`

Add stuff * router, partially from Pedestal * sample perf tests * kws expand to :name * fns expand to :handler 2017-08-08 12:31:00 +00:00			`Copyright © 2017 [Metosin Oy](http://www.metosin.fi)`
Initial commit 2017-08-07 11:08:39 +00:00
			`Distributed under the Eclipse Public License, the same as Clojure.`