@marinae/nextgen-design-system 0.1.0 → 0.1.2

package/README.md

@@ -1,73 +1,174 @@
-# React + TypeScript + Vite
+# NextGen Design System
 
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+A reusable design system containing design tokens and SCSS foundations for modern React applications.
 
-Currently, two official plugins are available:
+## Contents
 
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Oxc](https://oxc.rs)
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/)
+This package provides:
 
-## React Compiler
+* Color tokens
+* Typography tokens
+* Spacing tokens
+* Container tokens
+* Gradient tokens
+* Shadow tokens
+* Blur tokens
+* Utility mixins
 
-The React Compiler is not enabled on this template because of its impact on dev & build performances. To add it, see [this documentation](https://react.dev/learn/react-compiler/installation).
+The package is framework-agnostic and can be used with:
 
-## Expanding the ESLint configuration
+* React
+* React Aria
+* Base UI
+* Next.js
+* Vite
+* Storybook
 
-If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
+---
 
-```js
-export default defineConfig([
-  globalIgnores(['dist']),
-  {
-    files: ['**/*.{ts,tsx}'],
-    extends: [
-      // Other configs...
+## Installation
 
-      // Remove tseslint.configs.recommended and replace with this
-      tseslint.configs.recommendedTypeChecked,
-      // Alternatively, use this for stricter rules
-      tseslint.configs.strictTypeChecked,
-      // Optionally, add this for stylistic rules
-      tseslint.configs.stylisticTypeChecked,
+```bash
+npm install @marinae/nextgen-design-system
+```
+
+---
+
+## Usage
+
+Import the complete design system:
+
+```scss
+@use '@marinae/nextgen-design-system/style';
+```
+
+or:
+
+```ts
+import '@marinae/nextgen-design-system/style';
+```
+
+---
+
+## Available Tokens
+
+### Colors
+
+```scss
+var(--indico-primary-blue-500)
+var(--indico-gray-600)
+var(--indico-success-500)
+var(--indico-warning-500)
+var(--indico-error-500)
+```
+
+### Typography
+
+```scss
+var(--font-size-display-2xl)
+var(--font-size-display-xl)
+var(--font-size-display-lg)
+var(--font-size-display-md)
+
+var(--font-size-text-xl)
+var(--font-size-text-lg)
+var(--font-size-text-md)
+var(--font-size-text-sm)
+var(--font-size-text-xs)
+```
+
+### Spacing
+
+```scss
+var(--space-1)
+var(--space-2)
+var(--space-3)
+var(--space-4)
+var(--space-5)
+var(--space-6)
+var(--space-8)
+var(--space-10)
+var(--space-12)
+var(--space-16)
+var(--space-20)
+var(--space-24)
+var(--space-32)
+var(--space-40)
+var(--space-48)
+var(--space-56)
+var(--space-64)
+```
+
+### Containers
+
+```scss
+var(--container-sm)
+var(--container-md)
+var(--container-lg)
+var(--container-xl)
+```
+
+### Shadows
+
+```scss
+var(--shadow-xs)
+var(--shadow-sm)
+var(--shadow-md)
+var(--shadow-lg)
+var(--shadow-xl)
+```
+
+### Blur
 
-      // Other configs...
-    ],
-    languageOptions: {
-      parserOptions: {
-        project: ['./tsconfig.node.json', './tsconfig.app.json'],
-        tsconfigRootDir: import.meta.dirname,
-      },
-      // other options...
-    },
-  },
-])
+```scss
+var(--blur-xs)
+var(--blur-sm)
+var(--blur-md)
+var(--blur-lg)
+var(--blur-xl)
 ```
 
-You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:
-
-```js
-// eslint.config.js
-import reactX from 'eslint-plugin-react-x'
-import reactDom from 'eslint-plugin-react-dom'
-
-export default defineConfig([
-  globalIgnores(['dist']),
-  {
-    files: ['**/*.{ts,tsx}'],
-    extends: [
-      // Other configs...
-      // Enable lint rules for React
-      reactX.configs['recommended-typescript'],
-      // Enable lint rules for React DOM
-      reactDom.configs.recommended,
-    ],
-    languageOptions: {
-      parserOptions: {
-        project: ['./tsconfig.node.json', './tsconfig.app.json'],
-        tsconfigRootDir: import.meta.dirname,
-      },
-      // other options...
-    },
-  },
-])
+---
+
+## Example
+
+```scss
+.button {
+  background: var(--indico-primary-blue-500);
+  color: white;
+
+  padding: var(--space-3) var(--space-4);
+
+  border-radius: var(--radius-md);
+
+  box-shadow: var(--shadow-xs);
+}
 ```
+
+---
+
+## Development
+
+The design system is documented and maintained using Storybook.
+
+Storybook is used for development and documentation only and is not included in the published package.
+
+---
+
+## Versioning
+
+This package follows semantic versioning.
+
+Examples:
+
+```bash
+npm version patch
+npm version minor
+npm version major
+```
+
+---
+
+## License
+
+MIT

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@marinae/nextgen-design-system",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "private": false,
   "files": [
-    "src/style"
-    ],
+    "src/style",
+    "README.md"
+  ],
   "exports": {
     "./style": "./src/style/main.scss",
     "./style/*": "./src/style/*"
   }
-}
+}