Skip to content

Commit 88e046a

Browse files
minor extend of readme
1 parent 47938ce commit 88e046a

File tree

1 file changed

+38
-6
lines changed

1 file changed

+38
-6
lines changed

README.md

Lines changed: 38 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,45 @@
1+
![Logo](https://repository-images.githubusercontent.com/198229221/c0edf6c1-8699-481d-85f7-17b6ea0ffb26)
2+
13
# Bolt
2-
Bolt protocol library over TCP socket. Bolt protocol is created and in use for communication with [Neo4j](https://neo4j.com/) Graph database. The documentation is available at [https://7687.org/](https://7687.org/). This library is aimed to be low level and keep up with protocol messages architecture and specifications.
4+
Bolt protocol library over TCP socket. Bolt protocol is created and in use for communication with [Neo4j](https://neo4j.com/) Graph database. The Bolt documentation is available at [https://7687.org/](https://7687.org/). This library is aimed to be low level and keep up with protocol messages architecture and specifications.
35

46
![](https://img.shields.io/badge/phpunit-passed-success) ![](https://img.shields.io/github/stars/stefanak-michal/Bolt) ![](https://img.shields.io/packagist/dt/stefanak-michal/bolt) ![](https://img.shields.io/github/v/release/stefanak-michal/bolt) ![](https://img.shields.io/github/commits-since/stefanak-michal/bolt/latest)
57

6-
## [Version support](https://github.com/neo4j-php/Bolt/wiki/Version-support)
7-
## [Requirements](https://github.com/neo4j-php/Bolt/wiki/Requirements)
8-
## [Installation](https://github.com/neo4j-php/Bolt/wiki/Installation)
9-
## [Usage](https://github.com/neo4j-php/Bolt/wiki/Usage)
10-
## [Errors](https://github.com/neo4j-php/Bolt/wiki/Errors)
8+
## Version support
9+
10+
We are trying to keep up and this library supports **Neo4j <= 4.4**.
11+
12+
[More info](https://github.com/neo4j-php/Bolt/wiki/Version-support)
13+
14+
## Requirements
15+
16+
It's hard to live without all new features which means we keep at **PHP >= 7.1**.
17+
18+
[More info](https://github.com/neo4j-php/Bolt/wiki/Requirements)
19+
20+
## Installation
21+
22+
You can use composer or download this repository.
23+
24+
`composer require stefanak-michal/bolt`
25+
26+
[More info](https://github.com/neo4j-php/Bolt/wiki/Installation)
27+
28+
## Usage
29+
30+
Concept of usage is based on Bolt messages and mostly you need just these.
31+
32+
```php
33+
<?php
34+
$bolt = new \Bolt\Bolt(new \Bolt\connection\Socket());
35+
$protocol = $bolt->build();
36+
$protocol->hello(\Bolt\helpers\Auth::basic('neo4j', 'neo4j'));
37+
$stats = $protocol->run('RETURN 1 AS num, 2 AS cnt');
38+
$rows = $protocol->pull();
39+
```
40+
41+
[More info](https://github.com/neo4j-php/Bolt/wiki/Usage)
1142

1243
## Another solutions
44+
1345
https://neo4j.com/developer/php/

0 commit comments

Comments
 (0)