@yeverlibs/ds 1.0.0

package/README.md

@@ -0,0 +1,91 @@
+# @yever/design-system
+
+Biblioteca de componentes do Design System Yever.
+
+## Instalação
+
+```bash
+npm install @yever/design-system
+# ou
+yarn add @yever/design-system
+# ou
+pnpm add @yever/design-system
+```
+
+## Dependências Peer
+
+Este pacote requer as seguintes dependências peer:
+
+- `react` ^18.0.0
+- `react-dom` ^18.0.0
+- `next` ^14.0.0
+
+## Uso
+
+### Importar estilos
+
+No seu `app/layout.tsx` ou `_app.tsx`:
+
+```tsx
+import '@yever/design-system/styles'
+```
+
+### Configurar Tailwind
+
+Importe a configuração do Tailwind no seu `tailwind.config.js`:
+
+```js
+import designSystemConfig from '@yever/design-system/tailwind'
+
+export default {
+  ...designSystemConfig,
+  content: [
+    ...designSystemConfig.content,
+    './src/**/*.{js,ts,jsx,tsx}',
+  ],
+}
+```
+
+### Usar componentes
+
+```tsx
+import { Button, Input, Modal } from '@yever/design-system'
+
+function MyComponent() {
+  return (
+    <Button $variant="primary" $size="medium">
+      Clique aqui
+    </Button>
+  )
+}
+```
+
+## Build
+
+Para fazer build do pacote:
+
+```bash
+npm run build
+```
+
+Isso irá gerar os arquivos compilados na pasta `dist/`.
+
+## Desenvolvimento
+
+Para desenvolvimento com watch mode:
+
+```bash
+npm run dev
+```
+
+## Estrutura
+
+- `src/_design-system/` - Componentes do design system
+- `src/lib/` - Utilitários
+- `src/utils/` - Funções auxiliares
+- `src/hooks/` - Hooks reutilizáveis
+- `src/@types/` - Definições de tipos TypeScript
+
+## Licença
+
+MIT