diff --git a/README.md b/README.md index ce868ae..a21c545 100644 --- a/README.md +++ b/README.md @@ -28,20 +28,10 @@ Clojure [tools.deps.alpha](https://github.com/clojure/tools.deps.alpha): ``` -## Parameters - -Datomic Ions provides facilities for accessing system -parameters. Refer to the [Ion Parameters](https://docs.datomic.com/cloud/ions/ions-reference.html#ion-parameters) -docs for an overview. The `io.pedestal.ions` namespace provides an interceptor fn, `datomic-params-interceptor`, -which makes these these parameters available on the Pedestal Context. Include this interceptor in your commons interceptor collection -to enable parameter support. If included, this interceptor makes parameters available on the Context through the following keys: +## Caveats -- `:io.pedestal.ions/app-info` Contains the results of `(ion/get-app-info)` -- `:io.pedestal.ions/env-map` Contains the results of `(ion/get-env)` -- `:io.pedestal.ions/params` Only present if the `:get-params?` option is provided. - Contains the results of `(ion/get-params {:path path})` - where `path` is calculated using :app-name and :env - from `app-info` and `env-map`, respectively. Param names are keywordized." +Going async either by returning a channel instead of a Context map or +response body is currently not supported. ## Usage @@ -104,6 +94,21 @@ Check out the [Pedestal Ions Sample](https://github.com/pedestal/pedestal-ions-s a fully functional sample and [example](https://github.com/pedestal/pedestal-ions-sample/blob/master/deps.edn) `deps.edn` configuration. +## Parameters + +Datomic Ions provides facilities for accessing system +parameters. Refer to the [Ion Parameters](https://docs.datomic.com/cloud/ions/ions-reference.html#ion-parameters) +docs for an overview. The `io.pedestal.ions` namespace provides an interceptor fn, `datomic-params-interceptor`, +which makes these these parameters available on the Pedestal Context. Include this interceptor in your commons interceptor collection +to enable parameter support. If included, this interceptor makes parameters available on the Context through the following keys: + +- `:io.pedestal.ions/app-info` Contains the results of `(ion/get-app-info)` +- `:io.pedestal.ions/env-map` Contains the results of `(ion/get-env)` +- `:io.pedestal.ions/params` Only present if the `:get-params?` option is provided. + Contains the results of `(ion/get-params {:path path})` + where `path` is calculated using :app-name and :env + from `app-info` and `env-map`, respectively. Param names are keywordized." + ## Contributing Thanks for your interest in contributing to pedestal.ions! This project is governed by the same contribution guidelines as dictated in the [Contributing to Pedestal](https://github.com/pedestal/pedestal/blob/master/CONTRIBUTING.md) document. Please have a look and sign a [Cognitect Contributor Agreement](https://secure.echosign.com/public/hostedForm?formid=8JU33Z7A7JX84U) before submitting a PR.