Skip to content

Commit 2af3570

Browse files
committed
temporary commit
1 parent c2585d9 commit 2af3570

File tree

2 files changed

+40
-36
lines changed

2 files changed

+40
-36
lines changed

Contributing.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@ Thank you for your interest in contributing to the Neo4j QueryAPI PHP Client! We
55
## Getting Started
66

77
1. **Fork the Repository**\
8-
Click the "Fork" button at the top right of the repository page.
8+
9+
10+
Click the "Fork" button at the top right of the repository page.
911

1012
2. **Clone Your Fork**
1113

@@ -15,23 +17,29 @@ Thank you for your interest in contributing to the Neo4j QueryAPI PHP Client! We
1517
```
1618

1719
3. **Set Up the Environment**
20+
1821

19-
- Ensure you have PHP installed (compatible with PHP < 7.1).
20-
- Install dependencies using Composer:
22+
23+
- Ensure you have PHP installed (compatible with PHP < 8.1).
24+
- Install dependencies using Composer:
2125

2226
```bash
23-
composer install
27+
composer install
2428
```
2529

26-
- Copy the `phpunit.dist.xml` file to `phpunit.xml` and configure the necessary environment variables like `NEO4J_ADDRESS`, `NEO4J_USERNAME`, `NEO4J_PASSWORD`.
27-
30+
- Copy the `phpunit.dist.xml` file to `phpunit.xml` and configure the necessary environment variables like `NEO4J_ADDRESS`, `NEO4J_USERNAME`, `NEO4J_PASSWORD`.
31+
32+
2833

2934

30-
4. **Run Tests**\
31-
Our tests use PHPUnit. To run tests:
35+
4. **Run Tests**
36+
37+
38+
- Ensure you have PHP installed (compatible with PHP < 8.1).
39+
- Install dependencies using Composer:
3240

3341
```bash
34-
composer/phpunit
42+
composer install
3543
```
3644

3745
## Code Guidelines

README.md

Lines changed: 23 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
Neo4jQueryAPI client
1+
# Neo4jQueryAPI client
22

3-
The Neo4j QueryAPI client is for developers and data engineers who want to interact programmatically with Neo4j databases — running queries, handling results, and managing database configurations. It offers:
3+
## Interact programmatically with Top Graph Technology
44

55
- Easy configuration to pick and choose drivers
66
- An intuitive API for smooth query execution
@@ -12,10 +12,6 @@ The Neo4j QueryAPI client is for developers and data engineers who want to inter
1212

1313

1414

15-
# Query API
16-
17-
A PHP client for Neo4j, a graph database.
18-
1915
## Installation
2016

2117
You can install the package via Composer:
@@ -28,6 +24,7 @@ composer require this-repo/neo4j-client
2824

2925
### Connecting to Neo4j
3026

27+
3128
```php
3229
use Neo4j\QueryAPI\Neo4jQueryAPI;
3330
use Neo4j\QueryAPI\Authentication\AuthenticateInterface;
@@ -84,26 +81,25 @@ vendor/bin/phpunit
8481

8582
Cypher values and types map to these php types and classes:
8683

87-
| Cypher | PHP |
88-
|--------------------|:-----------------:|
89-
| Single name | |
90-
| Integer | ``` * int ``` |
91-
| Float | ``` * float ``` |
92-
| Boolean | ``` * bool ``` |
93-
| Null | ``` * null ``` |
94-
| String | ``` * string ``` |
95-
| Array | |
96-
| Date | |
97-
| Duration | |
98-
| 2D Point | |
99-
| 3D Point | |
100-
| Cartesian 2D Point | |
101-
| Cartesian 3D Point | |
102-
| Node | |
103-
| Path | |
104-
| Map | |
105-
| Exact name | |
106-
| Bookmarks | Yes |
84+
| Cypher | PHP |
85+
|--------------------|:---------------------------------------------------:|
86+
| List | ```* array``` |
87+
| Integer | ``` * int ``` |
88+
| Float | ``` * float ``` |
89+
| Boolean | ``` * bool ``` |
90+
| Null | ``` * null ``` |
91+
| String | ``` * string ``` |
92+
| Array | ```* array``` |
93+
| Local DateTime | |
94+
| Local Time | |
95+
| Zoned DateTime | |
96+
| Zoned Time | |
97+
| 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 ``` |
107103

108104
## Diving deeper:
109105

@@ -130,7 +126,7 @@ If you discover any security-related issues, please email *[email protected]*
130126

131127
## Credits
132128

133-
- [Your Name](https://github.com/your-github-username)
129+
- Created with ❤️ by Nagels
134130
- [All Contributors](https://github.com/your-repo/neo4j-client/graphs/contributors)
135131

136132
## License

0 commit comments

Comments
 (0)