@snacky/ui 0.2.4 → 0.3.3

package/NOTICE

@@ -0,0 +1,41 @@
+Snacky App Design System
+========================
+
+The LICENSE file (MIT) covers the source code of this repository: the
+components, design tokens, generators, and the documentation site.
+
+Some bundled ASSETS are third-party work under their own licenses and are
+NOT covered by the MIT license. They are listed below. Downstream users who
+redistribute these assets must keep this attribution intact.
+
+
+UIcons by Flaticon
+------------------
+
+Applies to:
+  - assets/icons/icons.json
+  - packages/react-ui/src/icons/outline.tsx
+  - packages/react-ui/src/icons/solid.tsx
+  - packages/compose-ui/src/commonMain/kotlin/com/snacky/ui/components/icon/SnackyIcons.kt
+  - the `ICONS` registry embedded in index.html
+  - the compiled output of the above (e.g. @snacky/ui's dist/, the compose-ui
+    JAR published via JitPack)
+
+Creator:  Flaticon
+Source:   https://www.flaticon.com/uicons
+Figma:    https://www.figma.com/community/file/952131925958384905/uicons-by-flaticon-free-interface-icons
+License:  Creative Commons Attribution 4.0 International (CC BY 4.0)
+          https://creativecommons.org/licenses/by/4.0/
+
+Modifications: yes. The icons were exported from the Figma Community file
+above and transformed for this design system. Specifically: the SVG path
+geometry was extracted from the component sets, renamed from the Figma
+property values to semantic English names (for example Flaticon's `cod`
+became `truck`, `list` became `chevronRight`, and the Indonesian labels
+`riwayat`/`akun`/`Saldo`/`poin` became `history`/`account`/`balance`/
+`points`), and re-emitted as React components and Kotlin/Compose
+declarations. The drawn artwork itself is unchanged.
+
+Disclaimer of warranties: the licensed material is provided as-is and
+as-available, and the licensor makes no representations or warranties of any
+kind concerning it, as set out in Section 5 of CC BY 4.0.

package/README.md

@@ -15,7 +15,8 @@ npm install @snacky/ui
 ```
 
 Published at [npmjs.com/package/@snacky/ui](https://www.npmjs.com/package/@snacky/ui).
-To build from source instead (e.g. to work on the components themselves):
+To build from source instead (e.g. to work on the components themselves), clone
+[the repo](https://github.com/rezatresnas/snacky-design-system) and, from its root:
 
 ```bash
 cd packages/react-ui
@@ -26,7 +27,7 @@ npm run build
 ## Usage
 
 ```tsx
-import '@snacky/ui'; // pulls in theme/tokens.css as a side effect
+import '@snacky/ui/styles.css'; // required - the compiled bundle does not inject this for you
 import { Button, TextField, Checkbox } from '@snacky/ui';
 
 function SignupForm() {
@@ -102,16 +103,62 @@ per item - because that demo is only ever shown at a fixed 360px frame. A
 production nav bar needs to fill whatever width the real device is, so the
 flexible layout was kept on purpose.
 
+## Artwork credit and licensing
+
+The code in this package is MIT. The **icon artwork is not**: it is
+[UIcons by Flaticon](https://www.flaticon.com/uicons), used under
+[CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) and modified
+(exported from the Figma Community file and renamed to semantic English
+names).
+
+CC BY 4.0 allows redistribution, including inside this package, but the
+attribution has to travel with the artwork. It is embedded in
+`src/icons/*.tsx` and survives into the published bundle, and the full
+statement ships as `NOTICE`. **If you redistribute these icons - vendoring
+them, re-exporting them, publishing your own package built on them - keep
+that credit.** Using them in an app you ship needs no visible credit beyond
+what is already in the bundle.
+
 ## Known gaps - read before relying on these
 
-- **Icons** (`SnackyIcons.outline.*` / `SnackyIcons.solid.*`): only a starter
-  set is included (~30 outline, 3 solid), covering what's needed for a typical
-  form. The full documented set (41 outline + 10 solid) needs to be exported
-  from Figma's real icon components - the same way this whole design system
-  was built (`get_screenshot`/`download_assets` via the `figma-use` skill) -
-  and dropped into `src/icons/`. The starter set was hand-drawn as generic,
-  conventional UI glyphs; it does **not** claim pixel-fidelity to Figma.
-- **Illustration** ships no artwork - pass your own hosted `src`.
+- **Icons** (`SnackyIcons.outline.*` / `SnackyIcons.solid.*`): no longer a
+  gap. The hand-drawn starter set has been replaced by the real thing - all
+  42 Outline + 10 Solid icons exported from Figma's own `Icon-outline` (node
+  `55:2062`) and `Icon-solid` (`8772:5851`) component sets. `src/icons/outline.tsx` and
+  `solid.tsx` are generated from `../../assets/icons/icons.json` by
+  `../../scripts/generate-icons.js` (never hand-edit them), the same source
+  that generates compose-ui's `SnackyIcons.kt`.
+
+  Two things changed versus the old hand-drawn placeholder: the icons are
+  **filled outline shapes**, not stroked paths (the weight is baked into each
+  shape, there is no `strokeWidth` to set), and the set is **not uniform** -
+  icons are authored at 16, 20 or 24px depending on use, so each carries its
+  own viewBox and defaults to that natural size.
+- **Illustration** ships no artwork - you supply the image. This is
+  deliberate and normal (Material, Radix and Chakra ship none either); the
+  component owns the documented canvas size for each variant, which is the
+  part that belongs in a design system. The Snacky artwork itself is modified
+  stock and is not ours to redistribute.
+
+  ```tsx
+  import { Illustration } from '@snacky/ui';
+
+  <Illustration variant="empty" src="/img/empty.svg" alt="No products found" />
+  ```
+
+  Variant sizes are fixed: `empty` 268x200, `createAccount` 360x240,
+  `welcome` 200x200, `success` 200x200, `discountReferral` 268x200. Export
+  your artwork at those ratios (SVG preferred) and host it wherever your app
+  already serves static assets.
+
+  **Where to get artwork that fits:** [Open Peeps](https://www.openpeeps.com/)
+  is CC0 (public domain - no attribution, no restrictions), so it is the
+  easiest drop-in. [unDraw](https://undraw.co/) needs no attribution and
+  allows commercial use, but its licence forbids redistributing the assets
+  "in packs", so use it in your own app rather than re-publishing it inside a
+  library of your own. Either way, check the licence yourself before shipping
+  - it is the one part of this that a component library cannot decide for you.
+
 - **Modal/Section**: the design system documents ~9 Modal "variants" and ~13
   Section "variants", but each is really the *same* shell component
   (`BottomSheet` / `Section`) with different `children` - so that's what's