From ef58882848a48022e023df1dc2c24746418aa7ca Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Krist=C3=B3f=20Poduszl=C3=B3?=
 <14854048+kripod@users.noreply.github.com>
Date: Mon, 2 Sep 2024 22:58:25 +0200
Subject: [PATCH] docs: amend readme and change project description

---
 README.md    | 45 ++++++++++++++++++++++++++++++++++++++++++++-
 package.json |  2 +-
 2 files changed, 45 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 440bf56..c28397e 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,46 @@
 # juvo
 
-A design system based upon Tailwind CSS.
+Balanced design system built around the [Harmony color palette](https://github.com/evilmartians/harmony)
+
+## Principles
+
+- [WCAG 2.2](https://www.w3.org/TR/WCAG22/) compliance
+- [React Server Components](https://react.dev/reference/rsc/server-components) support
+- [React Hook Form](https://github.com/react-hook-form/react-hook-form) integration via `ref` prop for controls
+- Single container element for top-level UI components, allowing `className` to be prepended
+- [Utility-first CSS via Tailwind](https://tailwindcss.com/docs/utility-first)
+
+## Inspirations
+
+### Philosophy
+
+- [The “everything bagel” of components](https://dio.la/article/the-everything-bagel-of-components) — Dani Guardiola
+- [Reach UI Philosophy](https://gist.github.com/ryanflorence/e5c794e6093d16a69fa88d2112a292f7) — Ryan Florence
+- [Margin considered harmful](https://mxstbr.com/thoughts/margin) — Max Stoiber
+- [Contextual defaults](https://x.com/markdalgleish/status/1291180726218563590) — Mark Dalgleish
+- [Everything You Know About Web Design Just Changed](https://www.youtube.com/watch?v=jBwBACbRuGY) — Jen Simmons
+
+### Guidelines
+
+- [Web Interface Guidelines](https://interfaces.rauno.me/) — Rauno Freiberg
+- [Expressive React Component APIs with Discriminated Unions](https://blog.andrewbran.ch/expressive-react-component-apis-with-discriminated-unions/) — Andrew Branch
+
+### Accessibility
+
+- [HTML: The Inaccessible Parts](https://daverupert.com/2020/02/html-the-inaccessible-parts/) — Dave Rupert
+- [Using CSS to Enforce Accessibility](https://adrianroselli.com/2021/06/using-css-to-enforce-accessibility.html) — Adrian Roselli
+- [HTML Accessibility Blog](https://html5accessibility.com/stuff/) — Steve Faulkner
+- [Accessiblity Support](https://a11ysupport.io/) — Michael Fairchild
+
+### Design
+
+- [Material Design](https://m3.material.io/) — Google
+- [Visual design rules you can safely follow every time](https://www.anthonyhobday.com/sideprojects/saferules/) — Anthony Hobday
+- [Choosing the correct default easing for Popmotion](https://popmotion.io/blog/20170703-choosing-a-default-easing-for-popmotion/) — Matt Perry
+- [Practical UI](https://www.practical-ui.com/) — Adham Dannaway
+
+### Examples
+
+- [The Component Gallery](https://component.gallery/) — Iain Bean
+- [UI Playbook](https://uiplaybook.dev/) — Rauno Freiberg
+- [UI & UX Design Tips](https://www.uidesign.tips/) — Jim Raptis
diff --git a/package.json b/package.json
index 6c43d8b..a42b398 100644
--- a/package.json
+++ b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "juvo",
   "version": "0.0.0",
-  "description": "A design system based upon Tailwind CSS.",
+  "description": "Balanced design system built around the Harmony color palette",
   "keywords": [
     "design-system",
     "tailwindcss"