Skip to content

Commit 800a6d2

Browse files
committed
readme is altered with few more changes
1 parent 2af3570 commit 800a6d2

File tree

1 file changed

+44
-29
lines changed

1 file changed

+44
-29
lines changed

README.md

Lines changed: 44 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,45 @@
1-
# Neo4jQueryAPI client
1+
# Neo4j Query API client
22

33
## Interact programmatically with Top Graph Technology
44

5-
- Easy configuration to pick and choose drivers
6-
- An intuitive API for smooth query execution
7-
- Extensibility for custom use cases
5+
- Easy to start with, just build your client in one line and start running queries
6+
- Use an intuitive API for smooth query execution
87
- Built and tested under close collaboration with the official Neo4j driver team
9-
- Easier to start with, just need a client to any neo4j instance
108
- Fully typed with Psalm and CS fixed for code quality
11-
- It does not supports Bolt, Rather compatible with HTTP, and auto-routed drivers
12-
9+
- Uses HTTP under the hood instead of bolt
10+
- Small, lightweight, well maintained and fully tested codebase
1311

1412

1513
## Installation
1614

1715
You can install the package via Composer:
1816

1917
```sh
20-
composer require this-repo/neo4j-client
18+
composer require neo4j-php/query-api
2119
```
2220

21+
## Client Installation
22+
23+
If you plan on using the HTTP drivers, make sure you have psr-7, psr-17, and psr-18 implementations included in your project.
24+
If you don't have any, you can install them via Composer:
25+
26+
```sh
27+
composer require psr/http-message psr/http-factory psr/http-client
28+
```
29+
30+
> **_NOTE:_** PSR-17 and PSR-18 are essential for HTTP client communication. Other compatible clients like Guzzle can also be used.
31+
> \* [PSR auto-discovery](https://docs.php-http.org/en/latest/discovery.html) will detect the installed HTTP client automatically.
32+
2333
## Usage
2434

2535
### Connecting to Neo4j
2636

2737

2838
```php
2939
use Neo4j\QueryAPI\Neo4jQueryAPI;
30-
use Neo4j\QueryAPI\Authentication\AuthenticateInterface;
40+
use Neo4j\QueryAPI\Objects\Authentication;
3141

32-
$client = Neo4jQueryAPI::login('http://localhost:7474', new AuthenticateInterface('username', 'password'));
42+
$client = Neo4jQueryAPI::login('http://localhost:7474', Authentication::basic('username', 'password'));
3343
```
3444

3545
### Running a Query
@@ -90,29 +100,34 @@ Cypher values and types map to these php types and classes:
90100
| Null | ``` * null ``` |
91101
| String | ``` * string ``` |
92102
| Array | ```* array``` |
93-
| Local DateTime | |
94-
| Local Time | |
95-
| Zoned DateTime | |
96-
| Zoned Time | |
103+
| Local DateTime | ``` * string ``` (will be upgraded in version 1.1) |
104+
| Local Time | ``` * string ``` (will be upgraded in version 1.1) |
105+
| Zoned DateTime | ``` * string ``` (will be upgraded in version 1.1) |
106+
| Zoned Time | ``` * string ``` (will be upgraded in version 1.1) |
97107
| Duration | ``` * string ``` (will be upgraded in version 1.1) |
98-
| WGS 84 2D Point | ``` * string ``` (will be upgraded in version 1.1) |
99-
| WGS 84 3D Point | ``` * string ``` (will be upgraded in version 1.1) |
100-
| Cartesian 2D Point | ``` * string ``` (will be upgraded in version 1.1) |
101-
| Cartesian 3D Point | ``` * string ``` (will be upgraded in version 1.1) |
102-
| Map | ``` * string ``` |
108+
| WGS 84 2D Point | `Neo4j\QueryAPI\Objects\Point` |
109+
| WGS 84 3D Point | `Neo4j\QueryAPI\Objects\Point` |
110+
| Cartesian 2D Point | `Neo4j\QueryAPI\Objects\Point` |
111+
| Cartesian 3D Point | `Neo4j\QueryAPI\Objects\Point` |
112+
| Map | ``` * array ``` |
113+
| Node | ```Neo4j\QueryAPI\Objects\Node ``` |
114+
| Relationship | ```Neo4j\QueryAPI\Objects\Relationship ``` |
115+
| Path | ```Neo4j\QueryAPI\Objects\Relationship``` |
103116

104117
## Diving deeper:
105118

106-
| Feature | Supported? |
107-
|----------|:-------------:|
108-
| Authentication | Yes |
109-
| Transaction | Yes |
110-
| HTTP | Yes |
111-
| Cluster | Yes |
112-
| Aura | Partly (recent versions) |
113-
| Bookmarks | Yes |
119+
| Feature | Supported? |
120+
|----------|:----------:|
121+
| Authentication | Yes |
122+
| Transaction | Yes |
123+
| HTTP | Yes |
124+
| Cluster | Partly* |
125+
| Aura | Yes |
126+
| Bookmarks | Yes |
127+
| Bolt | No |
114128

115-
> **_NOTE:_** It supports neo4j databases versions > 5.25 (which has QueryAPI enabled.)
129+
> **_NOTE:_** It supports neo4j databases versions > 5.25 or Neo4j Aura (which has QueryAPI enabled.)
130+
> \* Client side routing is only supported in the Neo4j driver
116131
117132

118133

@@ -127,7 +142,7 @@ If you discover any security-related issues, please email *[email protected]*
127142
## Credits
128143

129144
- Created with ❤️ by Nagels
130-
- [All Contributors](https://github.com/your-repo/neo4j-client/graphs/contributors)
145+
- [Ghlen Nagels](https://www.linkedin.com/in/ghlen/), [Kiran Chandani](https://www.linkedin.com/in/kiran-chandani-5628a1213/), [Pratiksha Zalte]()
131146

132147
## License
133148

0 commit comments

Comments
 (0)