Skip to content

Commit

Permalink
doc(readme): update
Browse files Browse the repository at this point in the history
  • Loading branch information
kkharji committed Jan 9, 2022
1 parent 398ae33 commit 80c62d7
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 2 deletions.
38 changes: 38 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,44 @@ passed in `#duct.reitit/logging{:types []}`
because logging shouldn't be done there.
</details></dd></dl>

### Module


<dl><dd><details><summary><a href="https://github.com/tami5/clj-duct-reitit/commit/398ae33c103b14b8c255f6cd5024e9877dc3fdd3"><tt>398ae33</tt></a> ♻️ Refactor: Total rewrite and decoupling</summary><br />- rename main router function key to `duct.reitit/router` instead of
`duct.router/reitit`.
- rename main handler function key to `duct.reitit/handler` instead of
`duct.handler/root`.
- create separate initializer for `duct.reitit/routes`. It seems to go
along the lines of decoupling processing steps.
- refactor `duct.module/reitit` and make more readable and easy to
reason with.
- move default config along with development and production profile
mutations to `duct/reitit/defaults.clj`.
- refactor reitit module initializer logic to somewhat general purpose
module initializer.

~~~clojure
(module/init
{:root :duct.reitit
:config config
:extra [(registry-tree registry)]
:store {:namespaces namespaces :routes routes}
:schema {::registry (registry-references registry)
::routes [:routes :namespaces ::registry]
::router [::routes ::options ::log]
::log ::options
::handler [::router ::options ::log]}})
~~~
This make create modules similar duct.reitit easier.
TODO: move to external library.
- change tests to reflect new changes
- remove many redundant files.
</details></dd></dl>

### Readme


- <a href="https://github.com/tami5/clj-duct-reitit/commit/6b2ce558004fee874be826adae9c405fc859b81f"><tt>6b2ce55</tt></a> 📚 Documentation: Update
### Tests


Expand Down
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
# Duct module.reitit


A [Duct][] module that sets [reitit][] as the application router with ring as a handler.
A [Duct][] module that sets [reitit][] as the application router with ring as a
handler. It provides two keys: `duct.reitit/router` an instance of
`reitit.ring/router` and `duct.reitit/handler` which is an instance of
`reitit.ring/ring-handler`

[duct]: https://github.com/duct-framework/duct
[reitit]: https://github.com/metosin/reitit
Expand All @@ -10,7 +13,7 @@ A [Duct][] module that sets [reitit][] as the application router with ring as a

To install, add the following to your project `:dependencies`:

[duct/module.reitit "0.1.0"]
[duct/module.reitit "0.3.0"]

## Usage

Expand Down

0 comments on commit 80c62d7

Please sign in to comment.