Skip to content

Commit

Permalink
Feature/documentation overall improvements (#116)
Browse files Browse the repository at this point in the history
* Increase stale bot thresholds

* Add alternatives section to README

* Add info about loading different data sets
  • Loading branch information
danielcaldas committed Sep 29, 2018
1 parent bab583f commit 8ec7204
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 2 deletions.
4 changes: 2 additions & 2 deletions .github/stale.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# https://github.com/apps/stale
daysUntilStale: 30
daysUntilClose: 10
daysUntilStale: 40
daysUntilClose: 20
exemptLabels:
- pinned
- security
Expand Down
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,13 @@

[Here a live playground](https://danielcaldas.github.io/react-d3-graph/sandbox/index.html) page where you can interactively config your own graph, and generate a ready to use configuration! :sunglasses:

You can also load different datasets and configurations via URL query parameter, here are the links:

* [small dataset](https://goodguydaniel.com/react-d3-graph/sandbox/index.html?data=small)
* [custom node dataset](https://goodguydaniel.com/react-d3-graph/sandbox/index.html?data=custom-node)

Do you want to visualize your own data set on the live sandbox? Just submit a PR! You're welcome 😁

## Documentation :book:

Full documentation [here](https://danielcaldas.github.io/react-d3-graph/docs/index.html).
Expand Down Expand Up @@ -103,3 +110,7 @@ Check [this trello board](https://trello.com/b/KrnmFXha/react-d3-graph) where ev
## Contributions

Contributions are welcome fell free to submit new ideas/features, just open an issue or send me an email or something. If you are more a _hands on_ person, just submit a pull request.

## Alternatives (Not what you where looking for?)

Well if you scrolled this far maybe _react-d3-graph_ does not fulfill all your requirements 😭, but don't worry I got you covered! There are a lot of different and good alternatives out there, [here is a list with a few alternatives](http://anvaka.github.io/graph-drawing-libraries/#!/all#%2Fall). Btw, not in the previous list but also a valid alternative built by uber [uber/react-vis-force](https://github.com/uber/react-vis-force).

0 comments on commit 8ec7204

Please sign in to comment.