Skip to content

Commit 4cf084b

Browse files
committed
update the docs
1 parent 3ef5ce4 commit 4cf084b

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,38 @@ You can install the package via composer:
1616
composer require tapp/laravel-airtable
1717
```
1818

19+
Publish the config file:
20+
21+
```bash
22+
php artisan vendor:publish --provider="Tapp\Airtable\AirtableServiceProvider"
23+
```
24+
25+
Define airtables account information:
26+
27+
```bash
28+
AIRTABLE_KEY=
29+
AIRTABLE_BASE=
30+
AIRTABLE_TABLE=
31+
```
32+
33+
* `AIRTABLE_KEY` can be retrieved here: https://airtable.com/account
34+
* `AIRTABLE_BASE` can be found here: https://airtable.com/api, select base then copy from URL: `https://airtable.com/[Base Is Here]/api/docs#curl/introduction`
35+
* `AIRTABLE_TABLE` can be found in the docs for the appropriate base, this is not case senstive. IE: `tasks`
36+
1937
## Usage
2038

39+
Get all records from that table.
40+
2141
``` php
2242
Airtable::table('tasks')->get();
2343
```
2444

45+
Get one record from the default table.
46+
47+
``` php
48+
Airtable::find('id_string');
49+
```
50+
2551
### Testing
2652

2753
``` bash

0 commit comments

Comments
 (0)