Skip to content

Commit 430130a

Browse files
authored
docs: update Readme
1 parent 8d0ba5c commit 430130a

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
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 (

0 commit comments

Comments
 (0)