Skip to content

Commit 87b6099

Browse files
authored
docs: update Readme
1 parent c4a8742 commit 87b6099

File tree

1 file changed

+38
-11
lines changed

1 file changed

+38
-11
lines changed

README.md

Lines changed: 38 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,12 @@ EXEMPLO
9898
<img alt="NextJS" width="50" height="50" src="https://github.com/DIGOARTHUR/github-automated-repos/assets/59892368/6b213e2e-213a-489d-bbda-1dec9dcda585"> ![Check](https://img.shields.io/badge/-Framework%20settings-yellow)
9999

100100
</div>
101-
101+
102+
<br>
103+
<br>
104+
105+
> [!TIP]
106+
> Use the code example in this documentation. [Code Example](https://github.com/DIGOARTHUR/github-automated-repos/tree/main?tab=readme-ov-file#code-example-1)
102107
103108
## 1. Installation
104109

@@ -109,8 +114,7 @@ EXEMPLO
109114
```
110115

111116
## 2. hook config.
112-
> [!TIP]
113-
> Use the code example in this documentation. [Code Example](https://github.com/DIGOARTHUR/github-automated-repos/tree/main?tab=readme-ov-file#code-example-1)
117+
114118

115119
```typescript
116120
import {useGitHubAutomatedRepos} from "github-automated-repos";
@@ -265,24 +269,47 @@ Array(0)
265269
```
266270
<br>
267271

268-
- `StackIcons` component returns, based on the iteration of the topics array, icons of the stacks used in your project. Insert the stacks used in the topics field of your repository. Check the [Stack Icons](https://github-automated-repos.vercel.app/documentation/stackIcons) tab!
272+
- `StackIcons` The component returns, based on the iteration of the topic array that is contained in data, icons of the stacks used in your project. Enter the stacks used in your repository's topic field.. Check the [Stack Icons](https://github-automated-repos.vercel.app/documentation/stackIcons) tab!
269273

270274
```tsx
271-
<StackIcons key={ } itemTopics={ } className={ } />
275+
data.map((item) => {
276+
return (
277+
...
278+
{item.topics.map((icon, index) => {
279+
return (
280+
<StackIcons key={index} itemTopics={ icon} className={ } />
281+
}
282+
...
272283
```
273284
<br>
274285
275-
- `StackLabels` component returns, based on the iteration of the topics array, labels of the stacks used in your project. Insert the stacks used in the topics field of your repository. Check the [Stack Icons](https://github-automated-repos.vercel.app/documentation/stackIcons) tab!
286+
- `StackLabels` component returns, based on the iteration of the topics array that is contained in data, labels of the stacks used in your project. Insert the stacks used in the topics field of your repository. Check the [Stack Icons](https://github-automated-repos.vercel.app/documentation/stackIcons) tab!
276287
277288
```tsx
278-
<StackLabes key={ } itemTopics={ } className={ } />
289+
data.map((item) => {
290+
return (
291+
...
292+
{item.topics.map((icon, index) => {
293+
return (
294+
<StackLabes key={ index } itemTopics={ icon} className={ } />
295+
}
296+
...
297+
279298
```
280299
<br>
281300
282-
- `ProjectIcons` component returns, based on the iteration of the topics array, icons to represent your project. The project tag must be inserted in the topics field of your repository. Check the [Project Icons](https://github-automated-repos.vercel.app/documentation/projectIcons) tab!
301+
- `ProjectIcons` component returns, based on the iteration of the topics array that is contained in data, icons to represent your project. The project tag must be inserted in the topics field of your repository. Check the [Project Icons](https://github-automated-repos.vercel.app/documentation/projectIcons) tab!
283302
284303
```tsx
285-
<ProjectIcons key={ } itemTopics={ } className={ } />
304+
data.map((item) => {
305+
return (
306+
...
307+
{item.topics.map((icon, index) => {
308+
return (
309+
<ProjectIcons key={ index } itemTopics={ icon } className={ } />
310+
}
311+
...
312+
286313
```
287314
288315
<br>
@@ -367,11 +394,11 @@ Array(0)
367394
</a>
368395

369396
{/*Stacks Icon and Stacks Label*/}
370-
{item.topics.map((icon) => {
397+
{item.topics.map((icon, index) => {
371398
return (
372399
<div key={icon} style={{display:'flex', justifyContent:'center'}}>
373400
<StackIcons key={icon} className="stack_Icon" itemTopics={icon} />
374-
<StackLabels key={icon} itemTopics={icon} />
401+
<StackLabels key={index} itemTopics={icon} />
375402
</div>
376403
)
377404
})}

0 commit comments

Comments
 (0)