Skip to content

Commit

Permalink
installation and configuration instructions in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Mulkave committed Jun 2, 2014
1 parent 92e7570 commit 1768a77
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,49 @@

Neo4j Graph Eloquent Driver for Laravel 4

## Installation

Add the package to your `composer.json` and run `composer update`.

```json
{
"require": {
"vinelab/neoeloquent": "*"
}
}
```

Add the service provider in `app/config/app.php`:

```php
'Vinelab\NeoEloquent\NeoEloquentServiceProvider',
```

The service provider will register all the required classes for this package and will also alias
the `Model` class to `NeoEloquent` so you can simply `extend NeoEloquent` in your models.

## Configuration
in `app/config/database.php` or in case of an environment-based configuration `app/config/[env]/database.php`
make `neo4j` your default connection:

```php
'default' => 'neo4j',
```

Add the connection defaults:

```php
'connections' => [
'neo4j' => [
'driver' => 'neo4j',
'host' => 'localhost',
'port' => '7474'
]
]
```

### Documentation

## Models

```php
Expand Down

0 comments on commit 1768a77

Please sign in to comment.