Skip to content

Commit 10d3251

Browse files
Add some explanation about seabolt to the readme.
1 parent 9347396 commit 10d3251

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,19 @@ Windows doesn't provide `pkg-config`, so have it installed by following [these i
2626

2727
### Seabolt
2828

29+
[Seabolt](http://github.com/neo4j-drivers/seabolt) is the C Connector Library for Neo4j and is used by the Go driver as the base layer.
30+
Seabolt can either be installed from binaries or from source.
31+
2932
#### Binaries
3033

31-
We're now providing _**experimental**_ binaries for `Linux`, `MacOS` and `Windows` [here](https://github.com/neo4j-drivers/seabolt/releases). Please remember that `OpenSSL` is a required dependency for `Linux` and `MacOS` - TLS on `Windows` depends on native SCHANNEL provider and doesn't require any additional third-party dependencies from version 1.7.3 onwards.
34+
We're provide _**experimental**_ binaries for `Linux`, `MacOS` and `Windows` [here](https://github.com/neo4j-drivers/seabolt/releases). Please remember that `OpenSSL` is a required dependency for `Linux` and `MacOS` - TLS on `Windows` depends on native SCHANNEL provider and doesn't require any additional third-party dependencies from version 1.7.3 onwards.
35+
36+
Download the binary matching your system and extract the package using the following command (assuming that you saved the package as ~/Downloads/seabolt.tar.gz).
37+
The command actually skips the top-level folder inside the tar.gz package and extracts its contents into the root folder `/`.:
38+
39+
```
40+
tar zxvf ~/Downloads/seabolt.tar.gz --strip-components=1 -C /
41+
```
3242

3343
#### Source
3444

@@ -40,6 +50,12 @@ Set `LD_LIBRARY_PATH`/`DYLD_LIBRARY_PATH` to include `<seabolt_install_dir>/lib`
4050

4151
Add `<seabolt_install_dir>\bin` to `PATH` environment variable on Windows.
4252

53+
There's a 3rd party tap for [brew](https://brew.sh) that you can use to download, compile and install Seabolt into the correct place on macOS: [homebrew-seabolt/seabolt](https://github.com/michael-simons/homebrew-seabolt):
54+
55+
```
56+
brew install michael-simons/homebrew-seabolt/seabolt
57+
```
58+
4359
## Getting the Driver
4460

4561
### With `dep`

0 commit comments

Comments
 (0)