Skip to content

Commit 1dab23a

Browse files
digoarthurdigoarthur
authored
docs: update Readme
1 parent 7eb4920 commit 1dab23a

File tree

1 file changed

+247
-4
lines changed

1 file changed

+247
-4
lines changed

‎README.md‎

Lines changed: 247 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,216 @@
1+
![213137554-83aa6798-9487-4d1b-a260-fd2035adaaad](https://github.com/DIGOARTHUR/github-automated-repos/assets/59892368/32856f40-e024-43a8-a418-d761488a5f67)
2+
![212284904-0b4f29fa-4141-4212-b516-d4e4fcdb8519](https://github.com/DIGOARTHUR/github-automated-repos/assets/59892368/9a05cfb2-0da2-4c13-bb0d-8bc0ba5beb80)
3+
![212284904-0b4f29fa-4141-4212-b516-d4e4fcdb8519](https://github.com/DIGOARTHUR/github-automated-repos/assets/59892368/a676f6d4-7f21-45df-9042-d8794ac28620)
4+
![212284904-0b4f29fa-4141-4212-b516-d4e4fcdb8519](https://github.com/DIGOARTHUR/github-automated-repos/assets/59892368/5a13da37-5ccc-42eb-a6b3-f6cc39ec9288)
5+
![Uploading 21313<?xml version="1.0" encoding="UTF-8" standalone="no"?>
6+
<!-- Uploaded to: SVG Repo, www.svgrepo.com, Transformed by: SVG Repo Mixer Tools -->
7+
8+
<svg
9+
fill="#000000"
10+
width="48.262558"
11+
height="35"
12+
viewBox="-5.12 -5.12 55.984567 40.6"
13+
version="1.1"
14+
xml:space="preserve"
15+
stroke="#000000"
16+
stroke-width="0.00064"
17+
id="svg1"
18+
sodipodi:docname="213137554-83aa6798-9487-4d1b-a260-fd2035adaaad.svg"
19+
inkscape:version="1.3 (0e150ed6c4, 2023-07-21)"
20+
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
21+
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
22+
xmlns="http://www.w3.org/2000/svg"
23+
xmlns:svg="http://www.w3.org/2000/svg"><defs
24+
id="defs1" /><sodipodi:namedview
25+
id="namedview1"
26+
pagecolor="#ffffff"
27+
bordercolor="#000000"
28+
borderopacity="0.25"
29+
inkscape:showpageshadow="2"
30+
inkscape:pageopacity="0.0"
31+
inkscape:pagecheckerboard="0"
32+
inkscape:deskcolor="#d1d1d1"
33+
inkscape:zoom="4.8613591"
34+
inkscape:cx="62.533952"
35+
inkscape:cy="19.130453"
36+
inkscape:window-width="1920"
37+
inkscape:window-height="1051"
38+
inkscape:window-x="-9"
39+
inkscape:window-y="-9"
40+
inkscape:window-maximized="1"
41+
inkscape:current-layer="svg1" />&#10;&#10;<g
42+
id="SVGRepo_bgCarrier"
43+
stroke-width="0"
44+
style="fill:#b3b3b3"
45+
transform="matrix(0.96665194,0,0,0.96665194,-8.0196465,-15.752862)" />&#10;&#10;<g
46+
id="SVGRepo_tracerCarrier"
47+
stroke-linecap="round"
48+
stroke-linejoin="round"
49+
style="fill:#b3b3b3"
50+
transform="matrix(0.96665194,0,0,0.96665194,-8.0196465,-15.752862)" />&#10;&#10;<g
51+
id="SVGRepo_iconCarrier"
52+
style="fill:#b3b3b3"
53+
transform="matrix(0.96665194,0,0,0.96665194,-8.0196465,-15.752862)"> <g
54+
id="smart_lamp"
55+
style="fill:#b3b3b3" /> <g
56+
id="e-wallet"
57+
style="fill:#b3b3b3" /> <g
58+
id="virtual_reality"
59+
style="fill:#b3b3b3" /> <g
60+
id="payment"
61+
style="fill:#b3b3b3" /> <g
62+
id="cloud_storage"
63+
style="fill:#b3b3b3" /> <g
64+
id="security_camera"
65+
style="fill:#b3b3b3" /> <g
66+
id="smart_home"
67+
style="fill:#b3b3b3" /> <g
68+
id="connection"
69+
style="fill:#b3b3b3" /> <g
70+
id="game"
71+
style="fill:#b3b3b3" /> <g
72+
id="drone"
73+
style="fill:#b3b3b3" /> <g
74+
id="smart_car"
75+
style="fill:#b3b3b3" /> <g
76+
id="camera"
77+
style="fill:#b3b3b3" /> <g
78+
id="online_business"
79+
style="fill:#b3b3b3" /> <g
80+
id="smartwatch"
81+
style="fill:#b3b3b3" /> <g
82+
id="online_shopping"
83+
style="fill:#b3b3b3"> <path
84+
d="M 60,16 H 19.4 L 19.3,15.5 C 19,14 17.8,13 16.3,13 H 14.8 C 14.4,11.8 13.3,11 12,11 H 4 c -0.6,0 -1,0.4 -1,1 v 4 c 0,0.6 0.4,1 1,1 h 8 c 1.3,0 2.4,-0.8 2.8,-2 h 1.5 c 0.5,0 0.9,0.4 1,0.8 l 4.5,25.3 -2.7,0.5 c -1.8,0.3 -3.1,1.8 -3.1,3.7 0,1 0.4,1.9 1.1,2.6 0.7,0.7 1.6,1.1 2.6,1.1 h 3.4 c 0.5,2.3 2.5,4 4.9,4 2.4,0 4.4,-1.7 4.9,-4 h 11.2 c 0.5,2.3 2.5,4 4.9,4 2.4,0 4.4,-1.7 4.9,-4 H 56 c 0.6,0 1,-0.4 1,-1 0,-0.6 -0.4,-1 -1,-1 h -2.1 c -0.5,-2.3 -2.5,-4 -4.9,-4 -2.4,0 -4.4,1.7 -4.9,4 H 32.9 c -0.5,-2.3 -2.5,-4 -4.9,-4 -2.4,0 -4.4,1.7 -4.9,4 H 19.7 C 19.2,47 18.8,46.8 18.5,46.5 18.2,46.2 18,45.7 18,45.3 c 0,-0.8 0.6,-1.5 1.4,-1.7 L 23.1,43 c 0,0 0,0 0,0 l 37,-6 c 0.5,-0.1 0.8,-0.5 0.8,-1 V 17 C 61,16.4 60.6,16 60,16 Z M 12,15 H 5 v -2 h 7 c 0.6,0 1,0.4 1,1 0,0.6 -0.4,1 -1,1 z m 37,30 c 1.7,0 3,1.3 3,3 0,1.7 -1.3,3 -3,3 -1.7,0 -3,-1.3 -3,-3 0,-1.7 1.3,-3 3,-3 z m -21,0 c 1.7,0 3,1.3 3,3 0,1.7 -1.3,3 -3,3 -1.7,0 -3,-1.3 -3,-3 0,-1.7 1.3,-3 3,-3 z m -5.3,-10.1 8.2,-1.1 1,5.7 -8.1,1.3 z m 16.4,-11.8 -8,0.4 -1,-5.5 h 8 z M 40.2,18 h 8 l 0.9,4.6 -7.9,0.4 z m -0.7,7.1 1,5.5 -8,1.1 -1.1,-6.1 z m -8.9,6.8 -8.2,1.1 -1.2,-7 8.3,-0.4 z m 2.3,1.7 8,-1.1 1,5.4 -8.1,1.3 z m 10,-1.4 7.9,-1 1,5.1 -7.9,1.3 z m -0.4,-1.9 -1,-5.3 8,-0.4 0.9,4.7 z m 9,-5.9 L 59,24 v 4.1 L 52.4,29 Z M 59,22.1 51.1,22.5 50.2,18 H 59 Z M 28.2,18 l 1,5.6 -8.3,0.4 c -0.1,0 -0.1,0 -0.1,0 l -1.1,-6 z m 25.6,18 -1,-5 6.2,-0.8 v 5 z"
85+
id="path1"
86+
style="fill:#b3b3b3" /> </g> <g
87+
id="smart_Television"
88+
style="fill:#b3b3b3" /> <g
89+
id="security"
90+
style="fill:#b3b3b3" /> <g
91+
id="communication"
92+
style="fill:#b3b3b3" /> <g
93+
id="remote_control"
94+
style="fill:#b3b3b3" /> <g
95+
id="satelite_dish"
96+
style="fill:#b3b3b3" /> </g>&#10;&#10;</svg>
97+
7554-83aa6798-9487-4d1b-a260-fd2035adaaad.svg…]()
98+
99+
100+
101+
102+
![Uploading 2<?xml version="1.0" encoding="UTF-8" standalone="no"?>
103+
<!-- Uploaded to: SVG Repo, www.svgrepo.com, Transformed by: SVG Repo Mixer Tools -->
104+
105+
<svg
106+
version="1.1"
107+
id="Uploaded to svgrepo.com"
108+
width="34.994572"
109+
height="25"
110+
viewBox="0 0 17.497286 12.5"
111+
xml:space="preserve"
112+
fill="#000000"
113+
sodipodi:docname="212284904-0b4f29fa-4141-4212-b516-d4e4fcdb8519.svg"
114+
inkscape:version="1.3 (0e150ed6c4, 2023-07-21)"
115+
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
116+
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
117+
xmlns="http://www.w3.org/2000/svg"
118+
xmlns:svg="http://www.w3.org/2000/svg"><defs
119+
id="defs1" /><sodipodi:namedview
120+
id="namedview1"
121+
pagecolor="#ffffff"
122+
bordercolor="#000000"
123+
borderopacity="0.25"
124+
inkscape:showpageshadow="2"
125+
inkscape:pageopacity="0.0"
126+
inkscape:pagecheckerboard="0"
127+
inkscape:deskcolor="#d1d1d1"
128+
inkscape:zoom="6.875"
129+
inkscape:cx="31.709091"
130+
inkscape:cy="29.527273"
131+
inkscape:window-width="1920"
132+
inkscape:window-height="1051"
133+
inkscape:window-x="-9"
134+
inkscape:window-y="-9"
135+
inkscape:window-maximized="1"
136+
inkscape:current-layer="Uploaded to svgrepo.com" />&#10;&#10;<g
137+
id="SVGRepo_bgCarrier"
138+
stroke-width="0"
139+
style="fill:#646cff;fill-opacity:1"
140+
transform="translate(-1.49475,-5.275)" />&#10;&#10;<g
141+
id="SVGRepo_tracerCarrier"
142+
stroke-linecap="round"
143+
stroke-linejoin="round"
144+
style="fill:#646cff;fill-opacity:1"
145+
transform="translate(-1.49475,-5.275)" />&#10;&#10;<g
146+
id="SVGRepo_iconCarrier"
147+
style="fill:#b3b3b3;fill-opacity:1"
148+
transform="matrix(0.6031363,0,0,0.6031363,-0.90153798,-3.181544)"> <style
149+
type="text/css"
150+
id="style1"> .feather_een{fill:#0B1719;} </style> <path
151+
class="feather_een"
152+
d="m 29.906,12.916 c 0.799,-0.349 0.799,-1.483 0,-1.832 L 17.202,5.526 C 16.819,5.358 16.41,5.275 16,5.275 c -0.41,0 -0.819,0.084 -1.202,0.252 L 2.094,11.084 c -0.799,0.35 -0.799,1.483 0,1.832 L 8,15.5 v 3.32 c 0,1.136 0.642,2.175 1.658,2.683 v 0 C 11.655,22.501 13.827,23 16,23 c 2.173,0 4.345,-0.499 6.341,-1.497 v 0 C 23.358,20.995 24,19.956 24,18.82 V 15.5 l 4,-1.75 V 21 c -0.552,0 -1,0.448 -1,1 v 3 c 0,0.552 0.448,1 1,1 h 1 c 0.552,0 1,-0.448 1,-1 v -3 c 0,-0.552 -0.448,-1 -1,-1 V 13.312 Z M 23,18.82 c 0,0.762 -0.424,1.448 -1.106,1.789 C 20.074,21.519 18.035,22 16,22 13.965,22 11.926,21.519 10.106,20.609 9.424,20.268 9,19.582 9,18.82 v -2.882 l 5.798,2.536 c 0.383,0.168 0.793,0.252 1.202,0.252 0.41,0 0.819,-0.084 1.202,-0.252 L 23,15.937 Z m -6.198,-1.262 c -0.254,0.111 -0.524,0.168 -0.802,0.168 -0.278,0 -0.547,-0.056 -0.802,-0.168 L 2.495,12 15.198,6.442 C 15.453,6.331 15.722,6.275 16,6.275 c 0.278,0 0.547,0.056 0.802,0.168 L 29.505,12 28.387,12.489 16.894,11.57 C 16.732,11.235 16.396,11 16,11 c -0.552,0 -1,0.448 -1,1 0,0.552 0.448,1 1,1 0.337,0 0.621,-0.178 0.802,-0.434 l 9.646,0.772 z"
153+
id="path1"
154+
style="fill:#b3b3b3;fill-opacity:1" /> </g>&#10;&#10;</svg>
155+
12284904-0b4f29fa-4141-4212-b516-d4e4fcdb8519.svg…]()
156+
157+
158+
![Upload<?xml version="1.0" encoding="UTF-8" standalone="no"?>
159+
<!-- Uploaded to: SVG Repo, www.svgrepo.com, Transformed by: SVG Repo Mixer Tools -->
160+
161+
<svg
162+
version="1.1"
163+
id="Uploaded to svgrepo.com"
164+
width="34.994572"
165+
height="25"
166+
viewBox="0 0 17.497286 12.5"
167+
xml:space="preserve"
168+
fill="#000000"
169+
sodipodi:docname="212284904-0b4f29fa-4141-4212-b516-d4e4fcdb8519.svg"
170+
inkscape:version="1.3 (0e150ed6c4, 2023-07-21)"
171+
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
172+
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
173+
xmlns="http://www.w3.org/2000/svg"
174+
xmlns:svg="http://www.w3.org/2000/svg"><defs
175+
id="defs1" /><sodipodi:namedview
176+
id="namedview1"
177+
pagecolor="#ffffff"
178+
bordercolor="#000000"
179+
borderopacity="0.25"
180+
inkscape:showpageshadow="2"
181+
inkscape:pageopacity="0.0"
182+
inkscape:pagecheckerboard="0"
183+
inkscape:deskcolor="#d1d1d1"
184+
inkscape:zoom="6.875"
185+
inkscape:cx="31.709091"
186+
inkscape:cy="17.890909"
187+
inkscape:window-width="1920"
188+
inkscape:window-height="1051"
189+
inkscape:window-x="-9"
190+
inkscape:window-y="-9"
191+
inkscape:window-maximized="1"
192+
inkscape:current-layer="Uploaded to svgrepo.com" />&#10;&#10;<g
193+
id="SVGRepo_bgCarrier"
194+
stroke-width="0"
195+
style="fill:#646cff;fill-opacity:1"
196+
transform="translate(-1.49475,-5.275)" />&#10;&#10;<g
197+
id="SVGRepo_tracerCarrier"
198+
stroke-linecap="round"
199+
stroke-linejoin="round"
200+
style="fill:#646cff;fill-opacity:1"
201+
transform="translate(-1.49475,-5.275)" />&#10;&#10;<g
202+
id="SVGRepo_iconCarrier"
203+
style="fill:#646cff;fill-opacity:1"
204+
transform="matrix(0.6031363,0,0,0.6031363,-0.90153798,-3.181544)"> <style
205+
type="text/css"
206+
id="style1"> .feather_een{fill:#0B1719;} </style> <path
207+
class="feather_een"
208+
d="m 29.906,12.916 c 0.799,-0.349 0.799,-1.483 0,-1.832 L 17.202,5.526 C 16.819,5.358 16.41,5.275 16,5.275 c -0.41,0 -0.819,0.084 -1.202,0.252 L 2.094,11.084 c -0.799,0.35 -0.799,1.483 0,1.832 L 8,15.5 v 3.32 c 0,1.136 0.642,2.175 1.658,2.683 v 0 C 11.655,22.501 13.827,23 16,23 c 2.173,0 4.345,-0.499 6.341,-1.497 v 0 C 23.358,20.995 24,19.956 24,18.82 V 15.5 l 4,-1.75 V 21 c -0.552,0 -1,0.448 -1,1 v 3 c 0,0.552 0.448,1 1,1 h 1 c 0.552,0 1,-0.448 1,-1 v -3 c 0,-0.552 -0.448,-1 -1,-1 V 13.312 Z M 23,18.82 c 0,0.762 -0.424,1.448 -1.106,1.789 C 20.074,21.519 18.035,22 16,22 13.965,22 11.926,21.519 10.106,20.609 9.424,20.268 9,19.582 9,18.82 v -2.882 l 5.798,2.536 c 0.383,0.168 0.793,0.252 1.202,0.252 0.41,0 0.819,-0.084 1.202,-0.252 L 23,15.937 Z m -6.198,-1.262 c -0.254,0.111 -0.524,0.168 -0.802,0.168 -0.278,0 -0.547,-0.056 -0.802,-0.168 L 2.495,12 15.198,6.442 C 15.453,6.331 15.722,6.275 16,6.275 c 0.278,0 0.547,0.056 0.802,0.168 L 29.505,12 28.387,12.489 16.894,11.57 C 16.732,11.235 16.396,11 16,11 c -0.552,0 -1,0.448 -1,1 0,0.552 0.448,1 1,1 0.337,0 0.621,-0.178 0.802,-0.434 l 9.646,0.772 z"
209+
id="path1"
210+
style="fill:#646cff;fill-opacity:1" /> </g>&#10;&#10;</svg>
211+
ing 212284904-0b4f29fa-4141-4212-b516-d4e4fcdb8519.svg…]()
212+
213+
1214

2215

3216
<!--Commit changes
@@ -259,11 +472,26 @@ Array(0)
259472

260473
### The package imports four elements:
261474

262-
- `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.
263-
475+
- `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 7 properties: banner, id, html_url, homepage, topics, name and description.
476+
264477
```tsx
265478
const data = useGitHubAutomatedRepos("GitHubUsername", "KeyWord");
266479
```
480+
- #### return data example:
481+
482+
``` javascript
483+
{
484+
banner:"https://raw.githubusercontent.com/DIGOARTHUR/github-automated-repos/main/src/assets/images/banner.png"
485+
description: "The library that automates, in one place, the administration of your github projects on your website."
486+
homepage: "https://github-automated-repos.vercel.app"
487+
html_url: "https://github.com/DIGOARTHUR/github-automated-repos"
488+
id: 585693873
489+
name: "github-automated-repos"
490+
topics: (8) ['automated', 'deploy', 'github', 'library', '
491+
}
492+
```
493+
494+
267495
<br>
268496
269497
- `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!
@@ -360,6 +588,23 @@ Array(0)
360588
361589
```
362590

591+
- #### Render component ProjectIcons example:
592+
593+
<div align="center">
594+
595+
![212284904-0b4f29fa-4141-4212-b516-d4e4fcdb8519](https://github.com/DIGOARTHUR/github-automated-repos/assets/59892368/9a05cfb2-0da2-4c13-bb0d-8bc0ba5beb80)
596+
![212284904-0b4f29fa-4141-4212-b516-d4e4fcdb8519](https://github.com/DIGOARTHUR/github-automated-repos/assets/59892368/9a05cfb2-0da2-4c13-bb0d-8bc0ba5beb80)
597+
![212284904-0b4f29fa-4141-4212-b516-d4e4fcdb8519](https://github.com/DIGOARTHUR/github-automated-repos/assets/59892368/9a05cfb2-0da2-4c13-bb0d-8bc0ba5beb80)
598+
![212284904-0b4f29fa-4141-4212-b516-d4e4fcdb8519](https://github.com/DIGOARTHUR/github-automated-repos/assets/59892368/9a05cfb2-0da2-4c13-bb0d-8bc0ba5beb80)
599+
![212284904-0b4f29fa-4141-4212-b516-d4e4fcdb8519](https://github.com/DIGOARTHUR/github-automated-repos/assets/59892368/9a05cfb2-0da2-4c13-bb0d-8bc0ba5beb80)
600+
![212284904-0b4f29fa-4141-4212-b516-d4e4fcdb8519](https://github.com/DIGOARTHUR/github-automated-repos/assets/59892368/9a05cfb2-0da2-4c13-bb0d-8bc0ba5beb80)
601+
602+
603+
</div>
604+
605+
606+
607+
363608
<br>
364609
<br>
365610

@@ -398,8 +643,6 @@ Array(0)
398643
<img alt="topics_Props" height="600" src="https://user-images.githubusercontent.com/59892368/219117029-d693ee8f-4289-4ac0-85ed-674091508510.png">
399644
</div>
400645
401-
402-
403646
<br>
404647
405648
- `name`: This is the name of the repository. Refers to the field Settings / General / Repository name of your GitHub.

0 commit comments

Comments
 (0)