Skip to content

Commit 315247d

Browse files
committed
Update README
1 parent fd90e73 commit 315247d

File tree

1 file changed

+16
-7
lines changed

1 file changed

+16
-7
lines changed

README.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,33 @@
1-
# \[your package name\]
1+
# react-zendesk-helpcenter
22

3-
\[package description\]
3+
React library that makes it easy to render Zendesk Help Center content in your React apps.
44

55
## Install
66

7-
Via [npm](https://npmjs.com/package/\[your-package-name\])
7+
Via [npm](https://npmjs.com/package/react-zendesk-helpcenter)
88

99
```sh
10-
npm install [your package name]
10+
npm install react-zendesk-helpcenter
1111
```
1212

13-
Via [Yarn](https://yarn.pm/\[your-package-name\])
13+
Via [Yarn](https://yarn.pm/react-zendesk-helpcenter)
1414

1515
```sh
16-
yarn add [your package name]
16+
yarn add react-zendesk-helpcenter
1717
```
1818

1919
## How to use
2020

21+
### `Article`
22+
23+
```
24+
import { Article } from 'react-zendesk-helpcenter'
25+
26+
const ArticlePage = ({ articleId }) => {
27+
return <Article articleId={articleId} domain="[your Zendesk subdomain]" />
28+
}
29+
```
2130

2231
## License
2332

24-
[MIT](LICENSE) © \[your copyright info\]
33+
[MIT](LICENSE) © [Ryan Hefner](https://www.ryanhefner.com)

0 commit comments

Comments
 (0)