orynn 0.1.0 → 0.2.0

package/README.md

@@ -1,19 +1,25 @@
 # orynn
 
-> A small, strongly-typed, JSON-driven form library for React.
+> A small, strongly-typed form library for React — themeable controls + a JSON-driven `Fieldset`.
 
-`orynn` gives you a `<Fieldset>` that renders a form from a config object, plus `<Input>` and
-`<Dropdown>` controls you can use entirely on their own. V1 is intentionally small — a clean
-foundation designed so validation, theming, and new field types can grow later without breaking
-the public API.
+`orynn` gives you a set of accessible, feature-rich form controls you can use on their own, a
+theming layer built on CSS custom properties, and a `<Fieldset>` that renders a whole form from
+a config object.
 
-- **JSON-driven** — describe fields in a strongly-typed config, get an accessible responsive form.
-- **Standalone controls** — `<Input>` and `<Dropdown>` work without `<Fieldset>`.
-- **Extensible by design** — field registry, pluggable validation resolver, CSS-variable tokens.
-- **Zero runtime dependencies** — `react` is the only peer. ESM + CJS. Tree-shakeable.
+**Controls (all standalone):**
+`Input` · `Textarea` · `NumberField` · `Dropdown` (combobox) · `DatePicker` ·
+`Checkbox` / `CheckboxGroup` · `Radio` / `RadioGroup` · `Field` primitive.
 
-> Status: `0.x`. The core API (`Fieldset`, `Input`, `Dropdown`, `useFieldsetState`) is stable in
-> intent; APIs marked `@experimental` (the field registry, `registerRule`) may change before `1.0`.
+- **Themeable** — `<OrynnProvider theme="…">` with presets, density, and custom accent / font /
+  radius / spacing. Zero-runtime: it only sets `--orynn-*` CSS variables.
+- **Feature-rich** — floating labels, adornments, clearable / loading, success & error states,
+  searchable + multi + grouped selects, a keyboard-navigable calendar, `Intl` number formatting.
+- **Extensible** — field registry, pluggable validation resolver, every value a design token.
+- **Small & tree-shakeable** — `react` is the only required peer (`react-dom` for the
+  `Dropdown` / `DatePicker` popovers). ESM + CJS.
+
+> Status: `0.2.x`. The control and theming APIs are stabilising; `@experimental` bits (the field
+> registry, `registerRule`) may still change before `1.0`.
 
 ## Install
 
@@ -46,25 +52,40 @@ export function Form() {
 }
 ```
 
-Standalone:
+## Standalone controls + theming
 
 ```tsx
-import { Input, Dropdown } from "orynn";
+import {
+  OrynnProvider, Input, Textarea, NumberField,
+  Dropdown, DatePicker, Checkbox, RadioGroup,
+} from "orynn";
+import "orynn/styles.css";
 
-<Input label="Name" value={name} onChange={setName} required />
-<Dropdown label="Country" value={country} onChange={setCountry} options={options} />
+<OrynnProvider theme={{ preset: "teal", radius: "lg", density: "comfortable" }}>
+  <Input label="Full name" floatingLabel clearable required />
+  <NumberField label="Budget" currency="USD" locale="en-US" min={0} />
+  <Dropdown
+    label="Country"
+    searchable
+    options={[
+      { label: "India", value: "IN", icon: "🇮🇳" },
+      { label: "Indonesia", value: "ID", icon: "🇮🇩" },
+    ]}
+  />
+  <DatePicker label="Start date" showToday clearable />
+  <Checkbox label="Email me updates" />
+</OrynnProvider>
 ```
 
+`theme` also accepts a preset shorthand (`theme="slate"`) or a custom accent
+(`theme={{ accent: "#e11d48" }}`). See [Theming](docs/theming.md).
+
 ## Docs
 
-- [Getting started](docs/getting-started.md)
-- [`Fieldset`](docs/fieldset.md) · [`Input`](docs/input.md) · [`Dropdown`](docs/dropdown.md)
-- [JSON configuration](docs/json-config.md)
-- [Validation](docs/validation.md)
-- [Layout](docs/layout.md)
-- [Extensibility](docs/extensibility.md)
-- [Accessibility](docs/accessibility.md)
-- [Architecture](ARCHITECTURE.md) · [Roadmap / postponed](FUTURE.md)
+- [Getting started](docs/getting-started.md) · [Theming](docs/theming.md) · [Controls](docs/controls.md)
+- [`Fieldset`](docs/fieldset.md) · [JSON configuration](docs/json-config.md) · [Validation](docs/validation.md)
+- [Layout](docs/layout.md) · [Extensibility](docs/extensibility.md) · [Accessibility](docs/accessibility.md)
+- [Changelog](CHANGELOG.md) · [Architecture](ARCHITECTURE.md) · [Roadmap](FUTURE.md)
 
 ## License