@mlw-packages/react-components 1.3.3 → 1.3.5

package/README.md

@@ -1,50 +1,53 @@
-# React + TypeScript + Vite
+# @malwee/react-components
 
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+Uma biblioteca de componentes React reutilizáveis para acelerar o desenvolvimento de aplicações web com design consistente, acessível e moderno.
 
-Currently, two official plugins are available:
+## Instalação
 
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
-
-## Expanding the ESLint configuration
+```bash
+npm install @malwee/react-components
+# ou
+yarn add @malwee/react-components
+```
 
-If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
+## Uso Básico
 
-- Configure the top-level `parserOptions` property like this:
+```tsx
+import { ButtonBase, CardBase } from '@malwee/react-components';
 
-```js
-export default tseslint.config({
-  languageOptions: {
-    // other options...
-    parserOptions: {
-      project: ['./tsconfig.node.json', './tsconfig.app.json'],
-      tsconfigRootDir: import.meta.dirname,
-    },
-  },
-})
+function App() {
+  return (
+    <CardBase>
+      <ButtonBase>Meu botão</ButtonBase>
+    </CardBase>
+  );
+}
 ```
 
-- Replace `tseslint.configs.recommended` to `tseslint.configs.recommendedTypeChecked` or `tseslint.configs.strictTypeChecked`
-- Optionally add `...tseslint.configs.stylisticTypeChecked`
-- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and update the config:
-
-```js
-// eslint.config.js
-import react from 'eslint-plugin-react'
-
-export default tseslint.config({
-  // Set the react version
-  settings: { react: { version: '18.3' } },
-  plugins: {
-    // Add the react plugin
-    react,
-  },
-  rules: {
-    // other rules...
-    // Enable its recommended rules
-    ...react.configs.recommended.rules,
-    ...react.configs['jsx-runtime'].rules,
-  },
-})
+## Componentes Disponíveis
+
+- Botões (`ButtonBase`)
+- Cartões (`CardBase`)
+- Inputs, Selects, Combobox, Checkbox, Switch, Tabs, Table, Tooltip, Dialog, Drawer, Sidebar, Avatar, Calendar, Carousel, Progress, Skeleton, Sonner, e outros.
+
+Veja a lista completa na pasta `src/components/ui` ou exemplos em `src/pages`.
+
+## Estilos
+
+Os componentes utilizam Tailwind CSS. Certifique-se de que seu projeto está configurado para usar Tailwind. Importe o CSS global:
+
+```tsx
+import '@malwee/react-components/style/global.css';
 ```
+
+## Documentação
+
+Consulte exemplos de uso e documentação dos componentes na pasta `src/pages`.
+
+## Contribuição
+
+Contribuições são bem-vindas! Abra uma issue ou envie um pull request.
+
+## Licença
+
+MIT