@marsaude/tokens 1.0.0 → 1.0.2

package/README.md

@@ -1,15 +1,87 @@
-# Basic Style Dictionary
+```markdown
+# Sira Design Tokens (@marsaude/tokens)
 
-This example code is bare-bones to show you what this framework can do. If you have the style-dictionary module installed globally, you can `cd` into this directory and run:
+Pacote de Design Tokens do Sira Design System. Este pacote contém as variáveis de estilo (cores, tipografia, espaçamentos) geradas automaticamente a partir do Style Dictionary.
 
+## 📦 Instalação
+
+Para instalar a versão mais recente no seu projeto:
+
+```bash
+npm install @marsaude/tokens
+
+```
+
+---
+
+## 🚀 Como Usar
+
+Este pacote expõe diferentes arquivos SCSS dependendo da sua necessidade (apenas variáveis ou classes utilitárias).
+
+### 1. Importando as Variáveis (Recomendado)
+
+Para ter acesso às variáveis CSS/SCSS (ex: cores, fontes) em todo o seu projeto, importe o arquivo principal no seu `styles.scss` global:
+
+```scss
+// No arquivo src/styles.scss
+@import '@marsaude/tokens/mobile';
+
+```
+
+**Exemplo de uso no CSS:**
+
+```scss
+.meu-componente {
+  // Use as variáveis CSS definidas pelos tokens
+  background-color: var(--mar-color-brand-primary);
+  padding: var(--mar-spacing-md);
+  border-radius: var(--mar-radius-sm);
+}
+
+```
+
+### 2. Importando Classes Utilitárias
+
+Se você precisa das classes utilitárias geradas (helpers), utilize o import específico:
+
+```scss
+@import '@marsaude/tokens/mobile-classes';
+
+```
+
+---
+
+## 🛠️ Desenvolvimento e Publicação (Para Mantenedores)
+
+### Como gerar os tokens
+
+Se você alterou os arquivos de configuração ou os tokens brutos, regenere os arquivos de build:
+
+```bash
+npm run build
+
+```
+
+### Como publicar uma nova versão
+
+O script de publicação já garante que o build seja rodado automaticamente antes de enviar.
+
+1. **Atualize a versão** (se necessário):
 ```bash
-npx style-dictionary build
+npm version patch
+
 ```
 
-Otherwise, install Style Dictionary locally for this project first, `cd` into this directory and run:
 
+2. **Publique no NPM:**
 ```bash
-npm init -y && npm install style-dictionary
+npm publish --access public
+
 ```
 
-and then run the above command.
+
+*(Certifique-se de que o token de acesso granular está configurado corretamente na sua máquina).*
+
+```
+
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@marsaude/tokens",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "type": "module",
   "description": "Design Tokens do Sira Design System",
   "publishConfig": {
@@ -17,8 +17,7 @@
   },
   "scripts": {
     "build": "node build-tokens.js --verbose",
-    "publish": "npm publish --access public",
-    "prepublishOnly": "npm run build"
+    "publish": "npm run build && npm publish --access public"
   },
   "devDependencies": {
     "@tokens-studio/sd-transforms": "^1.3.0",