@govbr-ds/webcomponents 1.6.2 → 1.7.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -95,47 +95,27 @@ Clone o projeto:
95
95
 
96
96
  ```bash
97
97
  git clone git@gitlab.com:govbr-ds/dev/wbc/govbr-ds-wbc.git
98
- ```
99
-
100
- Entre no diretório do projeto:
101
98
 
102
- ```bash
103
99
  cd govbr-ds-wbc
104
- ```
105
-
106
- Instale as dependências:
107
100
 
108
- ```bash
109
101
  npm install
110
- ```
111
-
112
- Para executar a nossa biblioteca a partir do código-fonte você tem 2 opções:
113
-
114
- ###  Executar como VueJS Components
115
102
 
116
- Nessa visualização você executa o projeto em uma página auxiliar (fora do storybook) e sem compilar o resultado para Web Components.
117
-
118
- ```node
119
- npm run serve
103
+ npm run storybook
120
104
  ```
121
105
 
122
- ###  Executar como Web Components
123
-
124
- Nessa visualização o projeto é executado a partir do storybook e convertido para Web Components.
106
+ ## Documentação
125
107
 
126
- Aqui você consegue testar as configurações, obter snippets de código e visualizar os componentes rodando como nos ambientes de produção.
108
+ Nossa documentação está disponível em <https://gov.br/ds/webcomponents/>.
127
109
 
128
- ```node
129
- npm run storybook
130
- ```
110
+ > Para outras informações, consulte nossa [Wiki](https://gov.br/ds/wiki/desenvolvimento/web-components/).
131
111
 
132
- 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.
112
+ ## Polyfill
133
113
 
134
- ## Documentação
114
+ 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).
135
115
 
136
- Nossa documentação está disponível em <https://gov.br/ds/webcomponents/>.
116
+ 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.
137
117
 
138
- > Para outras informações, consulte nossa [Wiki](https://govbr-ds.gitlab.io/tools/wiki/hugo-cms/desenvolvimento/web-components/).
118
+ Para aprender com instalar, consulte a [documentação oficial](https://github.com/webcomponents/polyfills/tree/master/packages/webcomponentsjs 'Polyfills')
139
119
 
140
120
  ## Contribuindo
141
121
 
@@ -151,6 +131,10 @@ Você pode usar as [issues](https://gitlab.com/govbr-ds/dev/wbc/govbr-ds-wbc/-/i
151
131
 
152
132
  Nos comprometemos a responder a todas as issues.
153
133
 
134
+ ## Commits
135
+
136
+ 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.
137
+
154
138
  ## Precisa de ajuda?
155
139
 
156
140
  > Por favor **não** crie issues para fazer perguntas...
@@ -165,18 +149,6 @@ Use nossos canais abaixo para obter tirar suas dúvidas:
165
149
 
166
150
  - Usando nosso canal no discord <https://discord.gg/U5GwPfqhUP>
167
151
 
168
- ## Commits
169
-
170
- 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.
171
-
172
- ## Apêndice
173
-
174
- ### Polyfill
175
-
176
- 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.
177
-
178
- Para aprender com instalar, consulte a [documentação oficial](https://github.com/webcomponents/polyfills/tree/master/packages/webcomponentsjs 'Polyfills')
179
-
180
152
  ## Créditos
181
153
 
182
154
  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.