README.md

# PrimerLive

<p>
An implementation of GitHub's <a href="https://primer.style/design/" target="blank">Primer Design System</a> for Phoenix LiveView.
</p>

<p>
Primer Design provides a strong base for creating data driven applications such as rich CRUD applications with interactive forms.
</p>

<p>
All PrimerLive components accept the <code>class</code> attribute for customisations (and often the <code>classes</code> struct to address inner elements). <a href="https://primer.style/design/foundations/css-utilities/getting-started" target="blank">Primer's utility classes</a> allow a wide range of customisations without having to write custom styles.
</p>

<p>
PrimerLive components can be used in <a href="https://github.com/phoenixframework/phoenix_live_view" target="_blank">Phoenix LiveView pages</a> and regular (non-LiveView) views in Phoenix applications.
</p>

<p>
Forms created with <a href"https://www.ash-hq.org/">Ash Framework</a> are supported.
</p>

## Documentation

- [Documentation at Hexdocs](https://hexdocs.pm/primer_live/)
- [Installation](doc-extra/installation.md)
- [Usage](doc-extra/usage.md)

## Resources

- [PrimerLive Storybook and Demo](https://primer-live.org)
- [Source code](https://github.com/ArthurClemens/primer_live)