Skip to content

Commit 4915c8e

Browse files
authored
Update README.md
1 parent 9763420 commit 4915c8e

1 file changed

Lines changed: 1 addition & 87 deletions

File tree

README.md

Lines changed: 1 addition & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -14,90 +14,4 @@ npm i @d2k/react-github --save
1414

1515
## Usage
1616

17-
### Get repos by username
18-
19-
```js
20-
import { useRepos } from "@d2k/react-github";
21-
22-
function MyComponent() {
23-
const { repos, loading, error } = useRepos("nat");
24-
25-
// your component
26-
}
27-
```
28-
29-
### Get user
30-
31-
```js
32-
import { useUser } from "@d2k/react-github";
33-
34-
function MyComponent() {
35-
const { user, loading, error } = useUser("nat");
36-
37-
// your component
38-
}
39-
```
40-
41-
### Get branches from repo
42-
43-
```js
44-
import { useBranches } from "@d2k/react-github";
45-
46-
function MyComponent() {
47-
const { branches, loading, error } = useBranches("facebook", "react");
48-
49-
// your component
50-
}
51-
```
52-
53-
### Get branch from repo
54-
55-
```js
56-
import { useBranch } from "@d2k/react-github";
57-
58-
function MyComponent() {
59-
const { branch, loading, error } = useBranch("facebook", "react", "master");
60-
61-
// your component
62-
}
63-
```
64-
65-
### Get latest release from repo
66-
67-
```js
68-
import { useLatestRelease } from "@d2k/react-github";
69-
70-
function MyComponent() {
71-
const { release, loading, error } = useLatestRelease("facebook", "react");
72-
73-
// your component
74-
}
75-
```
76-
77-
### Get release by tag from repo
78-
79-
```js
80-
import { useTaggedRelease } from "@d2k/react-github";
81-
82-
function MyComponent() {
83-
const { release, loading, error } = useTaggedRelease(
84-
"facebook",
85-
"react",
86-
"v16.8.4"
87-
);
88-
89-
// your component
90-
}
91-
```
92-
93-
### List forks from repo
94-
95-
```js
96-
import { useForks } from "@d2k/react-github";
97-
98-
function MyComponent() {
99-
const { forks, loading, error } = useForks("facebook", "react");
100-
101-
// your component
102-
}
103-
```
17+
# [Documentation](/wiki)

0 commit comments

Comments
 (0)