Skip to content

Commit 6efe0f4

Browse files
authored
docs: update Readme
1 parent 4d6bc6d commit 6efe0f4

File tree

1 file changed

+26
-32
lines changed

1 file changed

+26
-32
lines changed

README.md

Lines changed: 26 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -339,8 +339,9 @@ Array(0)
339339

340340

341341

342-
343-
<!------------------------------------DESCRIPTION-->
342+
<!-------------------------------------------------- -->
343+
<!------------------------------------------ DESCRIPTION-->
344+
<!-------------------------------------------------- -->
344345

345346
# <img alt="skills" width="40" height="40" src="https://user-images.githubusercontent.com/59892368/148622497-164365e8-f6b0-4f40-bc75-a0ed4da6059b.png"> About Library <!---write here : talk a little about project: what's does, example. -->
346347
> This library automates the view your GitHub projects on your website in one place. But how? Make the code configuration only once in your application with github-automated-repos, and manage the view of your projects on GitHub in the Topics field. Choose which project will be seen on your website, and you can even customize your project card, for example, with a representative icon and show which stacks were used. All in one place!
@@ -359,38 +360,20 @@ Array(0)
359360
| :-------------------------------------------------------------------: |
360361
| ![image](https://user-images.githubusercontent.com/59892368/214930109-119c4b38-9862-4a3d-a130-2dfad5c4bcb6.gif)|
361362

363+
364+
------
365+
<br/>
366+
362367

363368

364369
<!------------------------------------------------>
365-
<!------------------------------------LIBRARY -->
370+
<!------------------------------------ IMPORT -->
366371
<!-------------------------------------------- -->
367372

368-
# <img alt="skills" width="80" height="30" src="https://github.com/user-attachments/assets/b7c52fa3-ba47-4f19-8dd3-ccd9d6395b76"> Import &nbsp;&nbsp; <img height="25" src="https://github.com/user-attachments/assets/86de188b-2512-43e8-8ab8-a102e99e15a1" alt="language_USA" border="0"> <img height="25" src="https://github.com/user-attachments/assets/cd98a831-dc14-47bb-8735-fc83c60634bf" alt="language_USA" border="0"> <!---write here : demonstration of the application layout. -->
373+
# <img alt="skills" height="30" src="https://github.com/user-attachments/assets/b7c52fa3-ba47-4f19-8dd3-ccd9d6395b76"> Import &nbsp;&nbsp; <!---write here : demonstration of the application layout. -->
369374

370375

371-
372-
373-
<p align="left">
374-
375-
<a href="https://github.com/DIGOARTHUR/github-automated-repos#--sobre-a-aplicação-">
376-
<img height="35" src="https://github.com/user-attachments/assets/fa24923b-77a4-4ac5-ab83-215120c74296" alt="language_USA" >
377-
<a/> &nbsp;&nbsp;
378-
<a href="https://github.com/DIGOARTHUR/github-automated-repos#import-1">
379-
<img height="35" src="https://github.com/user-attachments/assets/ac3e4e9c-9db7-4b78-b9ff-cd4863b9342f" alt="language_USA" border="0">
380-
<a/>&nbsp;&nbsp;
381-
382-
<a href="https://github.com/DIGOARTHUR/github-automated-repos#fill-in-the-fields-in-the-github-repository-1">
383-
<img height="35" src="https://github.com/user-attachments/assets/66b424a6-f4ac-4e8b-8426-86454a59ee36" alt="language_USA" border="0">
384-
<a/>&nbsp;&nbsp;
385-
386-
<a href="https://github.com/DIGOARTHUR/github-automated-repos#code-example-1">
387-
<img height="35" src="https://github.com/user-attachments/assets/f86d5d29-821b-4f2f-b16b-df6fa5db5f82" alt="language_USA" border="0">
388-
<a/> &nbsp;&nbsp;
389-
<a href="https://github.com/DIGOARTHUR/github-automated-repos#framework-settings-1">
390-
<img height="35" src="https://github.com/user-attachments/assets/113d28df-530c-4440-b936-cafb60b159da" alt="language_USA" border="0">
391-
<a/>&nbsp;&nbsp;&nbsp;&nbsp;
392-
393-
376+
<details>
394377

395378

396379
</p>
@@ -469,7 +452,7 @@ import { useGitHubAutomatedRepos, ProjectIcons, StackIcons, StackLabels } from '
469452

470453
</div>
471454

472-
<br>
455+
<br>
473456
<br>
474457

475458
- `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!
@@ -531,15 +514,25 @@ import { useGitHubAutomatedRepos, ProjectIcons, StackIcons, StackLabels } from '
531514

532515

533516
</div>
534-
517+
</details>
535518

536519

537520

538-
<br>
539521
<br>
540-
541-
## Fill in the fields in the github repository
542522

523+
524+
525+
526+
<!------------------------------------ -------------------->
527+
<!------------------------------------ FILL IN THE FIELDS -->
528+
<!------------------------------------ -------------------->
529+
530+
531+
# <img alt="skills" width="40" height="40" src="https://github.com/user-attachments/assets/403167b1-57eb-4ee9-818d-a591c6885f91"> Fill in the fields in the github repository
532+
533+
<details>
534+
<br/>
535+
543536
- `banner`: This property returns a .PNG image. For this to be possible, the correct name must be entered in the file called `banner.png` and also the path. Ex.:
544537
```
545538
└── src
@@ -596,6 +589,7 @@ import { useGitHubAutomatedRepos, ProjectIcons, StackIcons, StackLabels } from '
596589
<img alt="description_Props" src="https://user-images.githubusercontent.com/59892368/219117260-5bdb1fbb-c58b-4ad9-938a-068b58c72f27.png">
597590
</div>
598591
592+
</details>
599593
600594
601595
<br>

0 commit comments

Comments
 (0)