Skip to content

Commit

Permalink
update doc resources, image and add hashRouter to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisrzhou committed Mar 5, 2019
1 parent 7fe66bb commit 65c88b4
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 3 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Simple React + D3 wordcloud component with powerful features. Uses the [`d3-cloud`](https://github.com/jasondavies/d3-cloud) layout.

![image](./wordcloud.png)
![image](https://github.com/chrisrzhou/react-wordcloud/raw/master/wordcloud.png)

## Install

Expand All @@ -12,9 +12,11 @@ yarn add https://github.com/chrisrzhou/react-wordcloud.git

Note that `react-wordcloud` requires `react^16.8.3` as a peer dependency.

> I will try to reach out to the NPM owner of `react-wordcloud` to see if this package can replace it :)
## Examples

View all documented examples at https://chrisrzhou.github.io/wordcloud/
View all documented examples at https://react-wordcloud.netlify.com/

A simple example using only required props:

Expand Down
1 change: 1 addition & 0 deletions doczrc.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
export default {
dest: 'dist/docs',
hashRouter: true,
menu: [
'README',
{
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
"bugs": {
"url": "https://github.com/chrisrzhou/react-wordcloud/issues"
},
"homepage": "https://wordcloud.chrisrzhou.io",
"homepage": "https://react-wordcloud.netlify.com/",
"scripts": {
"build": "rollup -c",
"build:docs": "yarn docz build",
Expand Down
Binary file modified wordcloud.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 65c88b4

Please sign in to comment.