README.md
# `Sanity.Components`
[![Package](https://img.shields.io/badge/-Package-important)](https://hex.pm/packages/sanity_components) [![Documentation](https://img.shields.io/badge/-Documentation-blueviolet)](https://hexdocs.pm/sanity_components)
Phoenix components for rendering Sanity CMS data, including portable text and images.
## Installation
The package can be installed by adding `sanity_components` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:sanity_components, "~> 0.2.0"}
]
end
```
## Usage
Start by fetching data from Sanity CMS using the [`sanity` client library](https://github.com/balexand/sanity). Components in this package expect map keys to be atoms in `underscore_case`. Use [`Sanity.atomize_and_underscore/1`](https://hexdocs.pm/sanity/Sanity.html#atomize_and_underscore/1) to convert keys to this format.
See docs for:
* [Rendering portable text](https://hexdocs.pm/sanity_components/Sanity.Components.PortableText.html)
* [Rendering sanity images](https://hexdocs.pm/sanity_components/Sanity.Components.Image.html)