Skip to content

Commit 5a96f88

Browse files
authored
docs: update Readme
1 parent d5f57e6 commit 5a96f88

File tree

1 file changed

+27
-10
lines changed

1 file changed

+27
-10
lines changed

README.md

Lines changed: 27 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -49,12 +49,22 @@ EXEMPLO
4949
<!---------------------PROJECT ICON-->
5050
<img src="https://user-images.githubusercontent.com/59892368/219479919-5e84de50-6b7d-4d42-bb6d-a466b450db84.svg" alt="angular-logo" width="150px" height="150px"/>
5151
<br>
52-
<i>Github-automated-repos is the lib that gives you the power to manage the view of your projects
52+
<i>Github-automated-repos is the lib that gives you the power to manage the view of your GitHub projects
5353
<br> on your website in one place!</i>
5454
<br>
55+
5556
</p>
5657

5758

59+
<!---
60+
• Install lib `github-automated-repos` ➥
61+
<br>
62+
• Configure the useGitHubAutomatedRepos hook with your GitHubUsername and KeyWord
63+
<br>
64+
• Ready! Now all projects can be managed on their own `GitHub`, in the `Topics field`.
65+
-->
66+
67+
5868
<!------------------------------------LINKS-->
5969

6070
<p align="center">
@@ -91,6 +101,22 @@ EXEMPLO
91101
</div>
92102
93103

104+
## Installation
105+
106+
```shell
107+
npm install github-automated-repos
108+
# or
109+
yarn add github-automated-repos
110+
```
111+
112+
hook config.
113+
114+
```typescript
115+
import {useGithubAutomatedRepos} from "github-automated-repos";
116+
117+
const data = useGithubAutomatedRepos("GitHubUsername", "KeyWord");
118+
119+
```
94120

95121

96122

@@ -164,17 +190,8 @@ EXEMPLO
164190

165191
# <img alt="skills" width="80" height="30" src="https://user-images.githubusercontent.com/59892368/216092858-a64d3a99-1b90-4946-b917-76eadefffb54.svg"> Library <!---write here : demonstration of the application layout. -->
166192

167-
## Install
168-
169-
```shell
170-
npm install github-automated-repos
171193

172-
```
173194

174-
```shell
175-
yarn add github-automated-repos
176-
177-
```
178195

179196
## Import
180197
```javascript

0 commit comments

Comments
 (0)