diff --git a/.github/workflows/release.action.yml b/.github/workflows/release.action.yml index b9176f93..e124aac4 100644 --- a/.github/workflows/release.action.yml +++ b/.github/workflows/release.action.yml @@ -3,9 +3,6 @@ name: 'Publish' on: release: types: [published] - push: - branches: - - 'feature/package-release' env: NODE_VERSION: 20.x diff --git a/README.md b/README.md index 7111e2c9..fde0f70c 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,5 @@ -

- - - +

+

Design System

@@ -12,11 +10,45 @@ ### Como usar -Para usar o Design System no seu projeto, siga os passos abaixo: +Para usar o Design System no seu projeto, execute o comando: -1. Crie um arquivo `.npmrc` na raiz do seu projeto; -2. Adicione o seguinte conteúdo nele: `@uxshop:registry=https://npm.pkg.github.com`; -3. Adicione o pacote como dependência: `npm install --save-dev @uxshop/design-system`; +``` +npm install @tray-tecnologia/design-system +``` + +### Importações + +Todos os componentes podem ser importados individualmente pelo nome global do pacote. + +```ts +import { Button } from '@tray-tecnologia/design-system'; +``` + +Caso deseja adicionar o Design System como um plugin da sua aplicação Vue com as diretivas já instaladas, use: + +```ts +import { DS } from '@tray-tecnologia/design-system/setup'; +``` + +Caso desejar importar os filtros ou as diretivas disponibilizadas pelo Design System: + +```ts +import { initials } from '@tray-tecnologia/design-system/filters'; +``` + +Caso deseja usar somente as diretivas: + +```ts +import directives from '@tray-tecnologia/design-system/directives'; +``` + +Caso precisar qualquer coisa relacionada aos estilos disponibilizados: + +```scss +import '@tray-tecnologia/design-system/theme'; +``` + +Vale ressaltar que a importação acima não engloba os estilos individuais dos componentes, somente a base usada por todo o Design System. Estão incluídos: normalização, helpers, mixins, tokens, variáveis, formulários, tabelas e tooltips. ### Versões diff --git a/public/icon.svg b/public/icon.svg new file mode 100644 index 00000000..1a3f908d --- /dev/null +++ b/public/icon.svg @@ -0,0 +1 @@ + \ No newline at end of file