Skip to content

Commit 9e80774

Browse files
authored
docs: update Readme
1 parent d071868 commit 9e80774

File tree

1 file changed

+35
-4
lines changed

1 file changed

+35
-4
lines changed

README.md

Lines changed: 35 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -317,29 +317,60 @@ Array(0)
317317
318318
## Fill in the fields in the github repository
319319
320+
- `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.:
321+
```
322+
└── src
323+
└── assets
324+
└── images
325+
└── `banner.png`
326+
├── ...
327+
```
328+
<div align="center">
329+
<img alt="dashgo_layout" height="150" src="https://github.com/DIGOARTHUR/github-automated-repos/assets/59892368/68f59bce-0d8f-4cea-81c9-01596d97f47e">
330+
<img alt="dashfincaneiro_layout" height="150" src="https://github.com/DIGOARTHUR/github-automated-repos/assets/59892368/86dac1db-d04a-462b-a2ea-f00db264dbad">
331+
<img alt="proffy_layout" height="150" src="https://github.com/DIGOARTHUR/github-automated-repos/assets/59892368/bfcd0785-ce8a-4327-8b8b-5de495528c3f">
332+
</div>
333+
334+
335+
320336
- `id`: repository identification number. used as parameter in the key tag. This field does not need to be filled in.
321337
- `html_url`: repository link. Used as the link of access. This field does not need to be filled in.
322338
- `homepage`: it's the access link to the built page, page deploy. About / Website of your GitHub.
323339
324-
![image](https://user-images.githubusercontent.com/59892368/219116735-a026d9b9-f5b9-4389-b8f1-619db2488368.png)
340+
<div align="center">
341+
<img alt="homepage_Props" height="600" src="https://user-images.githubusercontent.com/59892368/219116735-a026d9b9-f5b9-4389-b8f1-619db2488368.png">
342+
</div>
343+
325344
326345
<br>
327346
328347
- `topics`: array that brings information about the icons in [Project Icons](https://github-automated-repos.vercel.app/documentation/projectIcons) and [Stack Icons](https://github-automated-repos.vercel.app/documentation/stackIcons). Used in both ProjectIcon and StackIcon components. It is in this field that is passed the key configured in the hook. Refers to the field About / Topics of your GitHub.
329348
330-
![image](https://user-images.githubusercontent.com/59892368/219117029-d693ee8f-4289-4ac0-85ed-674091508510.png)
349+
<div align="center">
350+
<img alt="topics_Props" height="600" src="https://user-images.githubusercontent.com/59892368/219117029-d693ee8f-4289-4ac0-85ed-674091508510.png">
351+
</div>
352+
353+
331354
332355
<br>
333356
334357
- `name`: This is the name of the repository. Refers to the field Settings / General / Repository name of your GitHub.
335358
336-
![image](https://user-images.githubusercontent.com/59892368/219117097-43db2497-7f62-428e-85c6-ef3656da4cd2.png)
359+
<div align="center">
360+
<img alt="name_Props" height="600" src="https://user-images.githubusercontent.com/59892368/219117097-43db2497-7f62-428e-85c6-ef3656da4cd2.png">
361+
</div>
362+
363+
337364
338365
<br>
339366
340367
- `description`: This is the description given to your repository. Refers to the About /Description field of your GitHub.
341368
342-
![image](https://user-images.githubusercontent.com/59892368/219117260-5bdb1fbb-c58b-4ad9-938a-068b58c72f27.png)
369+
<div align="center">
370+
<img alt="description_Props" height="600" src="https://user-images.githubusercontent.com/59892368/219117260-5bdb1fbb-c58b-4ad9-938a-068b58c72f27.png">
371+
</div>
372+
373+
343374
344375
<br>
345376
<br>

0 commit comments

Comments
 (0)