karsten-design-system 1.0.8 → 1.0.10

package/README.md

@@ -5,57 +5,69 @@ Uma biblioteca de componentes React estilizados para projetos da Karsten, constr
 ## Instalação
 
 Com npm:
+
 ```bash
 npm install karsten-design-system
 ```
 
 Com yarn:
+
 ```bash
 yarn add karsten-design-system
 ```
 
-## Configuração do Tailwind
-
-Adicione ao seu tailwind.config.js:
-
-\```js
-/** @type {import('tailwindcss').Config} */
-module.exports = {
-  content: [
-    './src/**/*.{js,ts,jsx,tsx}',
-    './node_modules/karsten-design-system/**/*.{js,jsx,ts,tsx}'
-  ],
-  theme: {
-    extend: {},
-  },
-  plugins: [],
-}
-\```
+## Configuração do PrimeReact
+
+No main.tsx adicione:
+
+```js
+  import { StrictMode } from "react";
+  import { createRoot } from "react-dom/client";
+  import "./index.css";
+  import App from "./App.tsx";
+
+  import { PrimeReactProvider } from 'primereact/api'  //adicione o PrimeReactProvider
+  import Tailwind from 'primereact/passthrough/tailwind'; //importe o Tialwind
+  import './index.css'
+
+  createRoot(document.getElementById("root")!).render(
+    <StrictMode>
+      <PrimeReactProvider value={{ pt: Tailwind }}> {/* Envolva o app no Provider do PrimeReact */}
+        <App />
+      </PrimeReactProvider>
+    </StrictMode>
+  );
+```
 
 ## Pré-requisitos
 
 Esta biblioteca requer as seguintes dependências:
 
 - React 18 ou superior
-- PrimeReact 10 ou superior
 - React DOM 18 ou superior
 - Tailwind 3.4.0 ou superior
+- @types/date-fns 2 ou superior
+- Chart.js 4 ou superior
+- clsx 2 ou superior
+- Data-fns 1 ou superior
+- Primeicons 7 ou superior
+- Primereact 10 ou superior
+- Postcss 8 ou superior
+- Autoprefixer 10 ou superior
 
 ## Como usar
 
 1. Importe o componente desejado da biblioteca:
 
 ```jsx
-import { Button } from 'karsten-design-system';
+import { Button } from 'karsten-design-system'
 ```
 
 2. Use o componente em seu projeto:
 
 ```jsx
 function App() {
-  return (
-    <Button label="Clique aqui" />
-  );
+  return <Button label="Clique aqui" />
 }
 ```
 
@@ -92,7 +104,6 @@ Por exemplo:
 - `Table` - Tabela para exibição de dados estruturados.
 - `Toast` - Mensagens temporárias exibidas no canto da tela.
 
-
 ## Documentação
 
 Para uma documentação completa e exemplos, visite nosso [Storybook](link-do-seu-storybook).
@@ -102,6 +113,7 @@ Para uma documentação completa e exemplos, visite nosso [Storybook](link-do-se
 Para contribuir com o projeto:
 
 1. Clone o repositório
+
 ```bash
 git clone https://github.com/3035tech/karsten-design-system
 ```
@@ -109,11 +121,13 @@ git clone https://github.com/3035tech/karsten-design-system
 2. Instale as dependências
 
 Com npm:
+
 ```bash
 npm install
 ```
 
 Com yarn:
+
 ```bash
 yarn
 ```
@@ -121,11 +135,13 @@ yarn
 3. Execute o Storybook para desenvolvimento
 
 Com npm:
+
 ```bash
 npm run storybook
 ```
 
 Com yarn:
+
 ```bash
 yarn storybook
 ```
@@ -133,14 +149,15 @@ yarn storybook
 ## Scripts Disponíveis
 
 Com npm:
+
 - `npm run storybook` - Inicia o ambiente de desenvolvimento do Storybook
 - `npm run build` - Gera o build da biblioteca
 
 Com yarn:
+
 - `yarn storybook` - Inicia o ambiente de desenvolvimento do Storybook
 - `yarn build` - Gera o build da biblioteca
 
-
 ## Suporte
 
 Para suporte, entre em contato com 3035tech@3035tech.com.br.
@@ -150,11 +167,13 @@ Para suporte, entre em contato com 3035tech@3035tech.com.br.
 Se você encontrar o erro "peer dependencies missing", instale as dependências necessárias:
 
 Com npm:
+
 ```bash
 npm install react react-dom primereact
 ```
 
 Com yarn:
+
 ```bash
 yarn add react react-dom primereact
 ```