Skip to content

Commit a516f9d

Browse files
committed
add usaeg
1 parent 38ce250 commit a516f9d

File tree

1 file changed

+18
-5
lines changed

1 file changed

+18
-5
lines changed

README.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,30 @@
22

33
Gitbook plugin that provide [The Unofficial GitHub Watch & Fork Buttons](https://ghbtns.com/ "The Unofficial GitHub Watch & Fork Buttons").
44

5+
![screenshot](https://monosnap.com/file/pzLUbsaOvgah0aWPt6E0TqG0l73faX.png)
6+
57
## Installation
68

7-
- [ ] Describe the installation process
9+
npm install gitbook-plugin-github-buttons
810

911
## Usage
1012

11-
- [ ] Write usage instructions
12-
13-
## Tests
13+
Plugin Config
14+
15+
```json
16+
{
17+
"pluginsConfig": {
18+
"github-buttons": {
19+
"repo": "azu/JavaScript-Plugin-Architecture",
20+
"types": [
21+
"star",
22+
"watch"
23+
]
24+
}
25+
}
26+
}
27+
```
1428

15-
- [ ] Write How to Tests
1629

1730
## Contributing
1831

0 commit comments

Comments
 (0)