Merge pull request #7 from nginformatica/chore/migrate-styleguide

docs: add migration info to readme file
nginformatica · Jan 2, 2024 · 8379dc8 · 8379dc8
2 parents aca7be5 + 4999a0c
commit 8379dc8
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -7,6 +7,16 @@
     <h2 style='font-family: sans-serif;'> STYLEGUIDE </h2>
 </div>
 
+## This repository is migrating its functionalities to flipper-ui, in order to centralize the repositories and not duplicate dependencies. It will be deleted when all products that use this repository are migrated to use colors through flipper-ui.
+
+```ts
+before the migration:
+import { theme } from 'nginformatica-styleguide'
+
+after the migration:
+import { theme } from 'flipper-ui/theme'
+```
+
 A repository to center and document, initially, the colors of the NGInformatica Apps.
 
 ## :package: `Install` 

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "nginformatica-styleguide",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "A minimalist styleguide in NGInformatica apps",
   "main": "lib/index.js",
   "typings": "./index.d.ts",