feat: update README with current version and component list enhancements

This commit is contained in:
2026-06-09 14:47:58 +02:00
parent 4d7c882324
commit b61720fd24
+15 -11
View File
@@ -24,7 +24,7 @@ NDS provides a focused set of reusable Astro components with centralized design
## Project Status ## Project Status
> **ALPHA** — The library is under active development. Component APIs, token naming, and internal architecture may change before a stable release. > **ALPHA** — The library is under active development. Current version: `0.03.0`. Component APIs, token naming, and internal architecture may change before a stable release.
## Core Principles ## Core Principles
@@ -42,13 +42,15 @@ These are the components currently implemented in `src/components/`:
|---|---| |---|---|
| `Button` | Actions | | `Button` | Actions |
| `Toggle` | Actions | | `Toggle` | Actions |
| `Tabs` / `Tab` / `TabItem` / `TabContent` | Navigation | | `NumericStepper` | Actions |
| `Tab` / `TabItem` / `TabContent` | Navigation |
| `Link` | Layout | | `Link` | Layout |
| `ListItem` | Data Display | | `ListItem` / `ListItemTitle` / `ListItemSubtitle` | Data Display |
| `Notifications` | Feedback | | `Notification` | Feedback |
| `LoadingBar` | Feedback |
| `Icons` | Utility | | `Icons` | Utility |
> Many components listed in earlier versions of this README (Navbar, Sidebar, Card, Modal, etc.) are planned but not yet implemented. > Components such as Navbar, Sidebar, Card, and Modal are planned but not yet implemented.
## Design Tokens ## Design Tokens
@@ -67,6 +69,8 @@ All styling is controlled via CSS custom properties prefixed with `--nds-`, defi
## Installation ## Installation
Requires **Node.js >= 22.12.0**.
```bash ```bash
npm install @unkn0wndo3s/nova-design-system npm install @unkn0wndo3s/nova-design-system
``` ```
@@ -87,12 +91,12 @@ import { Button } from '@unkn0wndo3s/nova-design-system';
```astro ```astro
--- ---
import { Notifications } from '@unkn0wndo3s/nova-design-system'; import { Notification } from '@unkn0wndo3s/nova-design-system';
--- ---
<Notifications type="warning"> <Notification type="warning">
This is a warning message. This is a warning message.
</Notifications> </Notification>
``` ```
## Development ## Development
@@ -119,9 +123,7 @@ npm run dev
```bash ```bash
npm run build # Build the project npm run build # Build the project
npm run check # Type checking npm run preview # Preview the production build
npm run lint # Lint the codebase
npm run format # Format code
``` ```
### Project Structure ### Project Structure
@@ -133,9 +135,11 @@ src/
│ ├── Icons/ │ ├── Icons/
│ ├── Link/ │ ├── Link/
│ ├── ListItem/ │ ├── ListItem/
│ ├── LoadingBar/
│ ├── Notifications/ │ ├── Notifications/
│ ├── Tabs/ │ ├── Tabs/
│ ├── Toggle/ │ ├── Toggle/
│ ├── numericStepper/
│ └── index.ts │ └── index.ts
├── layouts/ # Astro layouts ├── layouts/ # Astro layouts
├── pages/ # Documentation pages ├── pages/ # Documentation pages