Skip to content

Commit

Permalink
Added caveats to README and reordered sections.
Browse files Browse the repository at this point in the history
  • Loading branch information
ddeaguiar committed Nov 10, 2018
1 parent 7146105 commit 61b3b1f
Showing 1 changed file with 18 additions and 13 deletions.
31 changes: 18 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit 61b3b1f

Please sign in to comment.