Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat/theme handling #109

Merged
merged 13 commits into from
Aug 12, 2023
Prev Previous commit
Next Next commit
Update README.md
  • Loading branch information
ArthurClemens committed Aug 12, 2023
commit 436fe2df8699d175ec95371b2817ec521633d0f4
27 changes: 22 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,28 @@
# PrimerLive

PrimerLive is a collection of function components that implements <a href="https://primer.style/" target="_blank">GitHub's Primer Design System</a>. It is intended for usage in <a href="https://github.com/phoenixframework/phoenix_live_view" target="_blank">Phoenix LiveView pages</a> and regular (non-LiveView) views in Phoenix applications.

PrimerLive components can be used in Phoenix LiveView pages and regular (non-LiveView) views in Phoenix applications.
<p>
An implementation of GitHub's <a href="https://primer.style/design/" target="blank">Primer Design System</a> using Phoenix LiveView.
</p>

<p>
The Primer Design System 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>

## Documentation

- [Documentation at Hexdocs](https://hexdocs.pm/primer_live/)
- [Storybook and examples](https://primer-live.org/)
- [Source code](https://github.com/ArthurClemens/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)