Skip to content

Commit f12eda1

Browse files
committed
Update docs
1 parent ef033b1 commit f12eda1

File tree

1 file changed

+29
-2
lines changed

1 file changed

+29
-2
lines changed

README.md

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,41 @@
22

33
Tested against Laravel 5.7 and Odoo 7 _(OpenERP 7)_.
44

5-
More docs to do, examples to write, and the write interfaces to produce.
5+
# Installation
6+
7+
Through composer:
8+
9+
composer require consilience/laravel-odoo-api-client
10+
11+
Note: pending release to packagist, the following entry in `composer.json`
12+
is needed to locate this package:
13+
14+
```json
15+
"repositories": [
16+
{
17+
"type": "vcs",
18+
"url": "https://github.com/consilience/laravel-odoo-api-client.git"
19+
}
20+
...
21+
]
22+
...
23+
```
24+
25+
# Publishing the Configuration
26+
27+
Publish `config\odoo-api.php` using the Laravel artisan command:
28+
29+
artisan vendor:publish --provider="Consilience\OdooApi\OdooServiceProvider"
30+
31+
A sample set of entries for `.env` can be found in `.env.example`.
632

733
# Example
834

935
A very simple example:
1036

1137
```php
12-
// The facade.
38+
39+
// This facade is auto-discoverec for Laravel 5.6+
1340

1441
use OdooApi;
1542

0 commit comments

Comments
 (0)