Skip to content

Commit 7c41360

Browse files
author
Xing Han Lu
committed
Add badges and move documentation section up to readme
1 parent d42b023 commit 7c41360

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Dash Cytoscape
1+
# Dash Cytoscape [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/plotly/dash-cytoscape/blob/master/LICENSE) [![PyPi Version](https://img.shields.io/pypi/v/dash-cytoscape.svg)](https://pypi.org/project/dash-cytoscape/)
22

3-
A Component Library for Dash aimed at facilitating network visualization in Python, wrapped around [Cytoscape.js](http://js.cytoscape.org/)
3+
A Component Library for Dash aimed at facilitating network visualization in Python, wrapped around [Cytoscape.js](http://js.cytoscape.org/).
44

55
Interacting with the stylesheet:
66
![usage-stylesheet-demo](https://raw.githubusercontent.com/plotly/dash-cytoscape/master/demos/images/usage-stylesheet-demo.gif)
@@ -55,6 +55,15 @@ if __name__ == '__main__':
5555
app.run_server(debug=True)
5656
```
5757

58+
59+
## Documentation
60+
61+
View the [Dash Cytoscape User Guide](https://dash.plot.ly/cytoscape/) to get started now. You can also use the [component reference](https://dash.plot.ly/cytoscape/reference/) to find how to use a certain feature.
62+
63+
To learn more about the core Dash components and how to use callbacks, view the [Dash documentation](https://dash.plot.ly/).
64+
65+
For supplementary information about the underlying Javascript API, view the [Cytoscape.js documentation](http://js.cytoscape.org/).
66+
5867
## Development
5968

6069
Please follow the following steps for local testing:
@@ -90,13 +99,6 @@ $ python setup.py install
9099
```
91100

92101

93-
## Documentation
94-
95-
For using Dash and for a Python-specific overview of Dash Cytoscape, view the [Dash User Guide](https://dash.plot.ly/). It's chock-full of examples, pro tips, and guiding principles.
96-
97-
For supplementary information about the underlying javascript API, view the [Cytoscape.js documentation](http://js.cytoscape.org/).
98-
99-
100102

101103
## Notes
102104

0 commit comments

Comments
 (0)