Skip to content

Commit 64ba0b8

Browse files
authored
Merge pull request #254 from neo4j/update-link-to-docs
update link to docs
2 parents 5bdec15 + e12eabb commit 64ba0b8

File tree

1 file changed

+25
-31
lines changed

1 file changed

+25
-31
lines changed

README.md

Lines changed: 25 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![Latest version](https://img.shields.io/pypi/v/neo4j-viz)](https://pypi.org/project/neo4j-viz/)
44
[![PyPI downloads month](https://img.shields.io/pypi/dm/neo4j-viz)](https://pypi.org/project/neo4j-viz/)
55
![Python versions](https://img.shields.io/pypi/pyversions/neo4j-viz)
6-
[![Documentation](https://img.shields.io/badge/Documentation-latest-blue)](https://neo4j.com/docs/nvl-python/preview/)
6+
[![Documentation](https://img.shields.io/badge/Documentation-latest-blue)](https://neo4j.com/docs/python-graph-visualization/)
77
[![Discord](https://img.shields.io/discord/787399249741479977?label=Chat&logo=discord)](https://discord.gg/neo4j)
88
[![Community forum](https://img.shields.io/website?down_color=lightgrey&down_message=offline&label=Forums&logo=discourse&up_color=green&up_message=online&url=https%3A%2F%2Fcommunity.neo4j.com%2F)](https://community.neo4j.com)
99
[![License](https://img.shields.io/pypi/l/neo4j-viz)](https://pypi.org/project/neo4j-viz/)
@@ -17,39 +17,36 @@ The package wraps the [Neo4j Visualization JavaScript library (NVL)](https://neo
1717

1818
![Example Graph](examples/example_cora_graph.png)
1919

20-
2120
## Some notable features
2221

23-
* Easy to import graphs represented as:
24-
* projections in the Neo4j Graph Data Science (GDS) library
25-
* graphs from Neo4j query results
26-
* pandas DataFrames
27-
* Node features:
28-
* Sizing
29-
* Colors
30-
* Captions
31-
* Pinning
32-
* On hover tooltip
33-
* Relationship features:
34-
* Colors
35-
* Captions
36-
* On hover tooltip
37-
* Graph features:
38-
* Zooming
39-
* Panning
40-
* Moving nodes
41-
* Using different layouts
42-
* Additional convenience functionality for:
43-
* Resizing nodes, optionally including scale normalization
44-
* Coloring nodes based on a property
45-
* Toggle whether nodes should be pinned or not
22+
- Easy to import graphs represented as:
23+
- projections in the Neo4j Graph Data Science (GDS) library
24+
- graphs from Neo4j query results
25+
- pandas DataFrames
26+
- Node features:
27+
- Sizing
28+
- Colors
29+
- Captions
30+
- Pinning
31+
- On hover tooltip
32+
- Relationship features:
33+
- Colors
34+
- Captions
35+
- On hover tooltip
36+
- Graph features:
37+
- Zooming
38+
- Panning
39+
- Moving nodes
40+
- Using different layouts
41+
- Additional convenience functionality for:
42+
- Resizing nodes, optionally including scale normalization
43+
- Coloring nodes based on a property
44+
- Toggle whether nodes should be pinned or not
4645

4746
Please note that this list is by no means exhaustive.
4847

49-
5048
## Getting started
5149

52-
5350
### Installation
5451

5552
Simply install with pip:
@@ -58,7 +55,6 @@ Simply install with pip:
5855
pip install neo4j-viz
5956
```
6057

61-
6258
### Basic usage
6359

6460
We will use a small toy graph representing the purchase history of a few people and products.
@@ -110,11 +106,9 @@ This will return a `IPython.display.HTML` object that can be rendered in a Jupyt
110106

111107
Please refer to the [documentation](https://neo4j.com/docs/nvl-python/preview/) for more details on the API and usage.
112108

113-
114109
### Examples
115110

116-
For some Jupyter Notebook and streamlit examples, checkout the [/examples](/examples) directory.
117-
111+
For some Jupyter Notebook and streamlit examples, checkout the [/examples](/examples) directory.
118112

119113
## Contributing
120114

0 commit comments

Comments
 (0)