Skip to content

Commit f04b644

Browse files
committed
📝 (readme) update readme
1 parent 27e38a2 commit f04b644

File tree

1 file changed

+6
-11
lines changed

1 file changed

+6
-11
lines changed

README.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,33 +2,28 @@
22

33
> GitHub integration for Docus.
44
5-
65
## Quick Setup
76

87
1. Add `@docus/github` dependency to your project:
98

109
```bash
11-
#using yarn
10+
# Using Yarn
1211
yarn add --dev @docus/github
13-
# using npm
12+
# Using NPM
1413
npm install --save-dev @docus/github
1514
```
1615

17-
1816
2. Add `@docus/github` to the `buildModules` section of your `nuxt.config.js`
1917

20-
```
18+
```js
2119
{
22-
buildModules: [
23-
'@docus/github'
24-
]
20+
buildModules: ['@docus/github']
2521
}
2622
```
2723

28-
2924
## Usage
3025

31-
### Get github releases using `$docus.data` util
26+
### Get GitHub releases using `$docus.data` util
3227

3328
```js
3429
$docus.data('github-releases')
@@ -38,4 +33,4 @@ $docus.data('github-releases')
3833

3934
1. Clone this repository
4035
2. Install dependencies using `yarn install`
41-
3. Start dev server using `yarn dev`
36+
3. Start dev server using `yarn dev`

0 commit comments

Comments
 (0)