Skip to content

Commit c0eb739

Browse files
authored
Update README.md
1 parent 37e0f48 commit c0eb739

1 file changed

Lines changed: 15 additions & 5 deletions

File tree

README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,23 +18,23 @@ This package requires the following tools/libraries to be installed in order to
1818
2. Clone [seabolt](http://github.com/neo4j-drivers/seabolt) (assume `<seabolt_dir>` to be the absolute path in which the clone resides) and make sure you can build it successfully (follow it's own instructions)
1919
3. Add/Update environment variable `PKG_CONFIG_PATH` to include `<seabolt_dir>/build`
2020
4. Add/Update environment variable `LD_LIBRARY_PATH` to include `<seabolt_dir>/build/lib`
21-
5. Get this package via `go get github.com/neo4j/neo4j-go-driver`
21+
5. Get this package via `go get github.com/neo4j/neo4j-go-driver/neo4j`
2222

2323
### MacOS
2424

2525
1. Install pkg-config via `brew install pkg-config`
2626
2. Clone [seabolt](http://github.com/neo4j-drivers/seabolt) (assume `<seabolt_dir>` to be the absolute path in which the clone resides) and make sure you can build it successfully,
2727
3. Add/Update environment variable `PKG_CONFIG_PATH` to include `build` subdirectory of seabolt, i.e. `$PKG_CONFIG_PATH:<seabolt_dir>/build`
2828
4. Add/Update environment variable `LD_LIBRARY_PATH` to include `<seabolt_dir>/build/lib`
29-
5. Go Get this package via `go get github.com/neo4j/neo4j-go-driver`
29+
5. Go Get this package via `go get github.com/neo4j/neo4j-go-driver/neo4j`
3030

3131
### Windows
3232

3333
1. Install a mingw toolchain (for instance MSYS2 from https://www.msys2.org/) for cgo support (seabolt include some instructions),
3434
2. Clone [seabolt](http://github.com/neo4j-drivers/seabolt) (assume `<seabolt_dir>` to be the absolute path in which the clone resides) and make sure you can build it successfully,
3535
3. Add/Update environment variable `PKG_CONFIG_PATH` to include `build` subdirectory of seabolt, i.e. `%PKG_CONFIG_PATH%;<seabolt_dir>/build`
3636
4. Update environment variable `PATH` to include `<seabolt_dir>/build/bin`
37-
5. Go Get this package via `go get github.com/neo4j/neo4j-go-driver`
37+
5. Go Get this package via `go get github.com/neo4j/neo4j-go-driver/neo4j`
3838

3939
## Versioning
4040

@@ -45,7 +45,7 @@ Although `master` branch contains the source code for the latest available relea
4545
Add the driver as a dependency with `dep`.
4646

4747
```
48-
dep ensure -add github.com/neo4j/neo4j-go-driver
48+
dep ensure -add github.com/neo4j/neo4j-go-driver/neo4j
4949
```
5050

5151
## Minimum Viable Snippet
@@ -88,6 +88,16 @@ if err = result.Err(); err != nil {
8888
}
8989
```
9090

91+
## Connecting to a causal cluster
92+
93+
You just need to use `bolt+routing` as the URL scheme and set host of the URL to one of your core members of the cluster.
94+
95+
```go
96+
if driver, err = neo4j.NewDriver("bolt+routing://localhost:7687", neo4j.BasicAuth("username", "password", "")); err != nil {
97+
return err // handle error
98+
}
99+
```
100+
91101
There are a few points that need to be highlighted:
92102
* Each `Driver` instance maintains a pool of connections inside, as a result, it is recommended to only use **one driver per application**.
93103
* It is considerably cheap to create new sessions and transactions, as sessions and transactions do not create new connections as long as there are free connections available in the connection pool.
@@ -143,7 +153,7 @@ The temporal types are introduced in Neo4j 3.4 series.
143153
You can create a 2-dimensional `Point` value using;
144154

145155
```go
146-
point := NewPoint(srId, 1.0, 2.0)
156+
point := NewPoint2D(srId, 1.0, 2.0)
147157
```
148158

149159
or a 3-dimensional `Point` value using;

0 commit comments

Comments
 (0)