From f278dc64921f0c66d22db3a3883c0151c66fcc78 Mon Sep 17 00:00:00 2001 From: Lais Vieira Date: Wed, 20 Jul 2022 15:22:37 -0300 Subject: [PATCH] fix: TW Review Signed-off-by: Lais Vieira --- README.md | 12 +++++++----- about.md | 3 ++- implementation.md | 4 ++-- usage.md | 8 ++++---- useCase.md | 2 +- 5 files changed, 16 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 8375be0..06870a5 100644 --- a/README.md +++ b/README.md @@ -8,17 +8,18 @@ ## **Visão Geral** -O **web-react-citric-plugin** adiciona uma biblioteca de componentes reutilizáveis que ajuda a criar interfaces de usuário duráveis de forma mais rápida e satisfatória. +O Plugin **web-react-citric-plugin** adiciona uma biblioteca de componentes reutilizáveis que ajuda a criar interfaces de usuário duráveis de forma mais rápida e satisfatória. ## **Uso** ### **Pré-requisitos** -Para utilizar este Plugin, é necessário ter uma Stack web-react criada pelo cli. +Para utilizar este Plugin, é necessário ter uma Stack web-react criada pelo **`STK CLI`**. #### Instalação Para fazer o download do **uxservices-web-react-citric-plugin**, siga os passos abaixo: -**Passo 1.** Copie a URL abaixo e cole no seu navegador/terminal: +**Passo 1.** Copie a URL abaixo e cole no seu navegador/terminal: + ``` https://github.com/stack-spot/web-react-citric-plugin.git ``` @@ -29,10 +30,11 @@ https://github.com/stack-spot/web-react-citric-plugin.git npm install --save citric ``` -Esta parte é **Opcional**, Abaixo está um exemplo de marcação de link usado para carregar fontes Citric de um CDN: +> Esta estapa é **Opcional**. Confira abaixo um exemplo de marcação de link usado para carregar fontes **Citric** de um **CDN**: + ``` ``` -Para conhecer mais sobre o Citric Design System acesse [**Citric**](https://citric.stackspot.com/). \ No newline at end of file +Para conhecer mais sobre o Citric Design System acesse [**este site**](https://citric.stackspot.com/). \ No newline at end of file diff --git a/about.md b/about.md index aefd05d..87763dd 100644 --- a/about.md +++ b/about.md @@ -1,2 +1,3 @@ O Plugin **`Citric`** adiciona uma biblioteca de componentes reutilizáveis que auxilia na construção, manutenção e evolução de produtos digitais de forma rápida e escalável. -Para conhecer mais sobre o Citric Design System acesse [**Citric**](https://citric.stackspot.com/). + +Para conhecer mais sobre o Citric Design System acesse [**este site**](https://citric.stackspot.com/). diff --git a/implementation.md b/implementation.md index b4ded9d..85bd071 100644 --- a/implementation.md +++ b/implementation.md @@ -1,7 +1,7 @@ #### Instalação Para utilizar o Plugin **Citric**, siga os passos abaixo: -**Passo 1.** Na pasta da aplicação react criada com o **`STK CLI`**, abra o terminal e execute o comando abaixo para adicionar o Plugin do Citric: +**Passo 1.** Na pasta da aplicação React criada com o **`STK CLI`**, abra o terminal e execute o comando abaixo para adicionar o Plugin do Citric: ```bash stk apply plugin uxservices-web-react/citric @@ -13,4 +13,4 @@ stk apply plugin uxservices-web-react/citric npm install ``` -Para conhecer mais sobre o Citric Design System acesse [**Citric**](https://citric.stackspot.com/). +Para conhecer mais sobre o Citric Design System acesse [**este site**](https://citric.stackspot.com/). diff --git a/usage.md b/usage.md index 3cb6867..a6a94f1 100644 --- a/usage.md +++ b/usage.md @@ -1,6 +1,6 @@ #### **Pré-requisitos** -Para utilizar este Plugin é necessário ter uma Stack react importada pelo **`STK CLI`** que você pode baixar [**aqui**](https://stackspot.com.br/). +Para utilizar este plugin é preciso ter instalado na sua máquina os itens abaixo: -Ter instalado: -- Node.js 16 ou superior -- O Template **`web-react-app-template`** ou o **`web-react-appshell-template`** já deve estar aplicado para poder utilizar este Plugin. +- Ter uma Stack React importada pelo [**`STK CLI`**](https://stackspot.com.br/); +- Node.js 16 ou superior; +- O Template **`web-react-app-template`** ou o **`web-react-appshell-template`** já aplicado. diff --git a/useCase.md b/useCase.md index 8145715..5dd9c6a 100644 --- a/useCase.md +++ b/useCase.md @@ -1 +1 @@ -O **web-react-citric-plugin** adiciona uma biblioteca de componentes reutilizáveis que ajuda a criar interfaces de usuário duráveis de forma mais rápida e satisfatória. \ No newline at end of file +O Plugin **web-react-citric-plugin** adiciona uma biblioteca de componentes reutilizáveis que ajuda a criar interfaces de usuário duráveis de forma mais rápida e satisfatória. \ No newline at end of file