@govbr-ds/webcomponents 2.0.0-next.1 → 2.0.0-next.3

package/README.md

@@ -1,6 +1,13 @@
 # Web Components GovBR-DS
 
-Biblioteca baseada no [GovBR-DS](https://gov.br/ds 'GovBR-DS') e construída usando Web Components para ser independente de frameworks.
+Nosso objetivo é disponibilizar uma biblioteca de componentes baseada no [GovBR-DS](https://gov.br/ds 'GovBR-DS') que possa ser consumida independente de frameworks ou tecnologias utilizadas nos projetos.
+
+## Demonstração
+
+Acesse nossos sites e veja nossos componentes em ação:
+
+- [Storybook - Produção](https://gov.br/ds/webcomponents/)
+- [Storybook - Desenvolvimento](https://govbr-ds.gitlab.io/wbc/govbr-ds-wbc/)
 
 ## Tecnologias
 
@@ -15,6 +22,10 @@ Esse projeto é desenvolvido usando:
 
 > Para saber mais detalhes sobre Web Components sugerimos que consulte o [MDN](https://developer.mozilla.org/pt-BR/docs/Web/Web_Components 'Web Components | MDN').
 
+## Documentações Complementares
+
+Consulte nossa a seção sobre Web Componente na nossa [Wiki](https://govbr-ds.gitlab.io/tools/wiki/hugo-cms/desenvolvimento/web-components) para obter mais informações.
+
 ## Uso
 
 Existem 2 maneiras de usar nossos Web Components:
@@ -57,32 +68,22 @@ Disponibilizamos alguns exemplos de como usar esse projeto com algumas tecnologi
 
 ```markdown
 /raiz
-└───public
-│ └───index.html
 └───src
-│ │───App.vue
-│ │───main.js
-│ │
-│ │───library
-│ │ │───lib.js
-│ │ │───components
-│ │ │───mixins
-│ │ └───util
-│ │───pages
-│ │───router
-│ └───stories
+│───library
+│ │───lib.js
+│ │───components
+│ │───mixins
+│ └───util
+└───stories
 ```
 
-- **public/index.html**: página inicial da aplicação Vue que faz uso dos componentes da biblioteca.
 - **src**
-  - **App.vue** e **main.js**: arquivos da aplicação Vue.
+  - **assets**: pasta com arquivos estáticos
   - **library**
     - **lib.js**: inicializa todos os custom elements e define o que faz parte da biblioteca. É usado para fazer o build final.
     - **components**: pasta com os componentes da biblioteca, seus testes e stories do storybook.
     - **mixins**: mixins que são usados em vários componentes.
     - **util**: funções criadas para facilitar ações dentro dos componentes
-  - **pages**: páginas da aplicação Vue. São os exemplos que usamos para testar
-  - **router**: arquivo com as rotas apontando para as páginas (pages) da aplicação Vue
   - **stories**: Arquivos com as stories gerais do storybook
 
 > Aplicação Vue é uma aplicação criada para testar rapidamente nossos componentes. Ela não é disponibilizada no build e nem disponibilizamos um site com ela.
@@ -93,45 +94,27 @@ Clone o projeto:
 
 ```bash
 git clone git@gitlab.com:govbr-ds/dev/wbc/govbr-ds-wbc.git
-```
-
-Entre no diretório do projeto:
 
-```bash
 cd govbr-ds-wbc
-```
-
-Instale as dependências:
 
-```bash
 npm install
-```
-
-Para executar a nossa biblioteca a partir do código-fonte você tem 2 opções:
-
-###  Executar como VueJS Components
-
-Nessa visualização você executa o projeto em uma página auxiliar (fora do storybook) e sem compilar o resultado para Web Components.
 
-```node
-npm run serve
+npm run storybook
 ```
 
-###  Executar como Web Components
+## Documentação
 
-Nessa visualização o projeto é executado a partir do storybook e convertido para Web Components.
+Nossa documentação está disponível em <https://gov.br/ds/webcomponents/>.
 
-Aqui você consegue testar as configurações, obter snippets de código e visualizar os componentes rodando como nos ambientes de produção.
+> Para outras informações, consulte nossa [Wiki](https://gov.br/ds/wiki/desenvolvimento/web-components/).
 
-```node
-npm run storybook
-```
+## Polyfill
 
-Essa compilação pode demorar para refletir as alterações na página. Assim, recomendamos que utilizem primeiro a execução como VueJS durante o desenvolvimento e quando considerarem as alterações maduras o suficiente façam os testes como Web Components.
+Acesse os seguintes links para entender mais sobre o suporte dos browsers a [Custom Elements](https://caniuse.com/custom-elementsv1) e a [Shadow Dom](https://caniuse.com/shadowdomv1).
 
-## Documentação
+Caso os requisitos do seu projeto incluam navegadores que não suportam completamente os Web Components, adicione os [polyfills](https://www.webcomponents.org/polyfills) ao seu projeto.
 
-Nossa documentação está disponível em <https://gov.br/ds/webcomponents/>.
+Para aprender com instalar, consulte a [documentação oficial](https://github.com/webcomponents/polyfills/tree/master/packages/webcomponentsjs 'Polyfills')
 
 ## Contribuindo
 
@@ -147,6 +130,10 @@ Você pode usar as [issues](https://gitlab.com/govbr-ds/dev/wbc/govbr-ds-wbc/-/i
 
 Nos comprometemos a responder a todas as issues.
 
+## Commits
+
+Nesse projeto usamos um padrão para branches e commits. Por favor observe a documentação na nossa [wiki](https://gov.br/ds/wiki/ 'Wiki') para aprender sobre os nossos padrões.
+
 ## Precisa de ajuda?
 
 > Por favor **não** crie issues para fazer perguntas...
@@ -161,18 +148,6 @@ Use nossos canais abaixo para obter tirar suas dúvidas:
 
 - Usando nosso canal no discord <https://discord.gg/U5GwPfqhUP>
 
-## Commits
-
-Nesse projeto usamos um padrão para branches e commits. Por favor observe a documentação na nossa [wiki](https://gov.br/ds/wiki/ 'Wiki') para aprender sobre os nossos padrões.
-
-## Apêndice
-
-### Polyfill
-
-Caso os requisitos do seu projeto incluam navegadores que não suportam completamente os Web Components, adicione os [polyfills](https://www.webcomponents.org/polyfills) ao seu projeto.
-
-Para aprender com instalar, consulte a [documentação oficial](https://github.com/webcomponents/polyfills/tree/master/packages/webcomponentsjs 'Polyfills')
-
 ## Créditos
 
 Os Web Components do [GovBR-DS](https://gov.br/ds/ 'GovBR-DS') são criados pelo [SERPRO](https://www.serpro.gov.br/ 'SERPRO | Serviço Federal de Processamento de Dados') e [Dataprev](https://www.dataprev.gov.br/ 'Dataprev | Empresa de Tecnologia e Informações da Previdência') juntamente com a participação da comunidade.