Skip to content

Commit 8a42ecd

Browse files
committed
Updated Readme and added zip file for Neo4j Desktop
1 parent 2257ad4 commit 8a42ecd

File tree

2 files changed

+42
-10
lines changed

2 files changed

+42
-10
lines changed

README.adoc

+42-10
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1+
:repo: https://github.com/neo4j-graph-examples/pole
12
//name of the graph example
2-
:name: POLE
3+
:name: pole
34
:long_name: Crime Investigation
45
//graph example description
56
:description: Explore connections in crime data using the POLE - Person, Object, Location, Event - model in a public dataset from Manchester, U.K.
@@ -9,12 +10,12 @@
910
:tags: pole, crime investigation, crime detection
1011
//graph example author
1112
:author: Joe Depeau
12-
//use a script to generate/process data? Set to either path for script, or false if not used
13+
//use a script to generate/process data? Set to either path for script, or nothing if not used
1314
:use-load-script: false
14-
//use a graph dump file for initial data set? Set to either path for dump file, or false if not used
15+
//use a graph dump file for initial data set? Set to either path for dump file, or nothing if not used
1516
:use-dump-file: data/pole.dump
1617
//use a plugin for the database, separate multiple plugins with comma. 'public' plugins are apoc, graph-algorithms.
17-
//other algorithms are specified by path, e.g. apoc,graph-algorithms; Set to false if not used
18+
//other algorithms are specified by path, e.g. apoc,graph-algorithms; Set to nothing if not used
1819
:use-plugin: graph-algorithms
1920
//target version of the database this example should run on
2021
:target-db-version: 3.5.14
@@ -25,20 +26,51 @@
2526
//rendered guide - will remove later
2627
:rendered-guide: https://guides.neo4j.com/sandbox/pole/index.html
2728
//guide for modelling decisions. Should be friendly enough to be converted into various document formats
28-
:model-guide:
29+
:model-guide: false
2930

30-
image::{icon}[]
31+
image::{repo}/raw/master/{icon}[width=100]
3132

32-
= {long_name} Graph Example
33+
== {long_name} Graph Example ({name})
3334

3435
Description: {description}
3536

3637
=== Setup
3738

38-
This is for version: {target-db-version}
39+
This is for Neo4j version: {target-db-version}
3940

4041
Required plugins: {use-plugin}
4142

42-
unrendered guide: {guide}
43+
Rendered guide available via: `:play {rendered-guide}`
4344

44-
rendered guide available from: {rendered-guide}
45+
Download the zip file link:{repo}/raw/master/{name}.zip[{name}.zip] and add it as "project from file" to https://neo4j.com/developer/neo4j-desktop[Neo4j Desktop^].
46+
47+
Load graph data via
48+
49+
ifeval::[{use-dump-file} != false]
50+
[source,shell,subs=attributes]
51+
----
52+
bin/neo4j-admin load --from {use-dump-file} [--database <database>]
53+
----
54+
55+
Or upload dump file to Neo4j Aura via https://console.neo4j.io/#import-instructions
56+
57+
endif::[]
58+
59+
ifeval::[{use-load-script} != false]
60+
61+
[source,shell,subs=attributes]
62+
----
63+
bin/cypher-shell -u neo4j -p <password> -f {use-load-script} [-d <database>]
64+
----
65+
66+
Or import in Neo4j Browser by dragging or pasting the content of {use-load-script}.
67+
68+
endif::[]
69+
70+
=== Feedback
71+
72+
Repository: {repo}
73+
74+
GitHub Issues: {repo}/issues
75+
76+
Browser Guide Source: link:{repo}/tree/master/{guide}[{guide}]

pole.zip

4.46 MB
Binary file not shown.

0 commit comments

Comments
 (0)