Skip to content

Commit d711dae

Browse files
committed
docs(readme): update Readme
2 parents 138397f + 7f67519 commit d711dae

File tree

2 files changed

+14
-14
lines changed

2 files changed

+14
-14
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -110,9 +110,9 @@ EXEMPLO
110110
hook config.
111111

112112
```typescript
113-
import {useGithubAutomatedRepos} from "github-automated-repos";
113+
import {useGitHubAutomatedRepos} from "github-automated-repos";
114114

115-
const data = useGithubAutomatedRepos("GitHubUsername", "KeyWord");
115+
const data = useGitHubAutomatedRepos("GitHubUsername", "KeyWord");
116116

117117
```
118118

@@ -192,16 +192,16 @@ hook config.
192192

193193
## Import
194194
```javascript
195-
import { useGithubAutomatedRepos, ProjectIcon, StackIcon } from 'github-automated-repos/index';
195+
import { useGitHubAutomatedRepos, ProjectIcon, StackIcon } from 'github-automated-repos/index';
196196
```
197197
<br>
198198

199199
### The package imports four elements:
200200

201-
- `useGithubAutomatedRepos` hook responsible for automating the repositories. It returns a function called dataGithubRepos, which takes two parameters: data (data that comes from the GitHub API) and the keyword (the latter responsible for showing the project on your website from the moment it is declared in the Topics field of the your Github repository). The dataGithubRepos returns, so optimized, an array of objects containing 6 properties: id, html_url, homepage, topics, name and description.
201+
- `useGitHubAutomatedRepos` hook responsible for automating the repositories. It returns a function called dataGithubRepos, which takes two parameters: data (data that comes from the GitHub API) and the keyword (the latter responsible for showing the project on your website from the moment it is declared in the Topics field of the your Github repository). The dataGithubRepos returns, so optimized, an array of objects containing 6 properties: id, html_url, homepage, topics, name and description.
202202

203203
```tsx
204-
const data = useGithubAutomatedRepos("GitHubUsername", "KeyWord");
204+
const data = useGitHubAutomatedRepos("GitHubUsername", "KeyWord");
205205
```
206206
<br>
207207

@@ -262,7 +262,7 @@ hook config.
262262
:exclamation::exclamation: Don't forget to fill in the fields: your GitHubUsername and keyWord (determined by you).
263263

264264
```javascript
265-
const data = useGithubAutomatedRepos("GitHubUsername", "KeyWord");
265+
const data = useGitHubAutomatedRepos("GitHubUsername", "KeyWord");
266266
```
267267

268268

@@ -272,7 +272,7 @@ hook config.
272272
import './App.css';
273273
import { useGitHubAutomatedRepos, ProjectIcons, StackIcons, StackLabels, } from 'github-automated-repos';
274274
function App() {
275-
{/*useGithubAutomatedRepos hook*/ }
275+
{/*useGitHubAutomatedRepos hook*/ }
276276
const data = useGitHubAutomatedRepos("GitHubUsername", "KeyWord");
277277

278278
return (

README_PT.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -99,9 +99,9 @@ EXEMPLO
9999
configuração do hook
100100

101101
```typescript
102-
import {useGithubAutomatedRepos} from "github-automated-repos";
102+
import {useGitHubAutomatedRepos} from "github-automated-repos";
103103

104-
const data = useGithubAutomatedRepos("GitHubUsername", "KeyWord");
104+
const data = useGitHubAutomatedRepos("GitHubUsername", "KeyWord");
105105

106106
```
107107

@@ -181,15 +181,15 @@ configuração do hook
181181

182182
## Importação
183183
```javascript
184-
import { useGithubAutomatedRepos, ProjectIcon, StackIcon, IGithubRepos} from 'github-automated-repos';
184+
import { useGitHubAutomatedRepos, ProjectIcon, StackIcon, IGithubRepos} from 'github-automated-repos';
185185
```
186186
### O pacote importa quatro recursos:
187187

188188

189-
- `useGithubAutomatedRepos` hook responsável por automatizar os repositórios. Ele retorna uma função chamada dataGithubRepos, que leva dois parâmetros: data (dados que vêm da API do GitHub) e a palavra-chave (esta última responsável por mostrar o projeto no seu site a partir do momento em que ele é declarado no campo Tópicos do seu Github repositório). O dataGithubRepos retorna, assim otimizado, um array de objetos contendo 6 propriedades: id, html_url, página inicial, tópicos, nome e descrição.
189+
- `useGitHubAutomatedRepos` hook responsável por automatizar os repositórios. Ele retorna uma função chamada dataGithubRepos, que leva dois parâmetros: data (dados que vêm da API do GitHub) e a palavra-chave (esta última responsável por mostrar o projeto no seu site a partir do momento em que ele é declarado no campo Tópicos do seu Github repositório). O dataGithubRepos retorna, assim otimizado, um array de objetos contendo 6 propriedades: id, html_url, página inicial, tópicos, nome e descrição.
190190

191191
```tsx
192-
const data = useGithubAutomatedRepos("GitHubUsername", "KeyWord");
192+
const data = useGitHubAutomatedRepos("GitHubUsername", "KeyWord");
193193
```
194194
<br>
195195

@@ -253,7 +253,7 @@ Usado nos componentes ProjectIcon e StackIcon. É neste campo que é passada a c
253253
seu nome de usuário do github e a palavra-chave (determinados por você).
254254

255255
```javascript
256-
const data = useGithubAutomatedRepos("GitHubUsername", "KeyWord");
256+
const data = useGitHubAutomatedRepos("GitHubUsername", "KeyWord");
257257
```
258258

259259
#### <a href="https://typicode.github.io/husky/#/"><img alt="Javascript" width="35" height="35" src="https://user-images.githubusercontent.com/59892368/210762527-ae3afe1f-fe36-46a9-98ad-35dbae4d1adf.svg"><a/> <a href="https://typicode.github.io/husky/#/"><img alt="Javascript" width="35" height="35" src="https://user-images.githubusercontent.com/59892368/219095611-551d532a-30fc-4873-b00e-0a8bbf8bb5ec.svg"><a/>
@@ -262,7 +262,7 @@ seu nome de usuário do github e a palavra-chave (determinados por você).
262262
import './App.css';
263263
import { useGitHubAutomatedRepos, ProjectIcons, StackIcons, StackLabels, } from 'github-automated-repos';
264264
function App() {
265-
{/*useGithubAutomatedRepos hook*/ }
265+
{/*useGitHubAutomatedRepos hook*/ }
266266
const data = useGitHubAutomatedRepos("GitHubUsername", "KeyWord");
267267

268268
return (

0 commit comments

Comments
 (0)