Cleaned up and added some needed steps to documenation. Also, attempting to create sidebar menu.

Signed-off-by: Adam Culp <adamculp@uws.net>

Author: adamculp

README.md

@@ -28,7 +28,7 @@ Via Composer
 $ composer require beachcasts/airtable-sdk-php
 ```
 
-## Usage
+## Quick Start
 
 Copy the file `.env.default` to `.env`, and update as needed.
 
@@ -40,6 +40,8 @@ require_once('vendor/autoload.php');
 use Beachcasts\Airtable\AirtableClient;
 use Beachcasts\Airtable\Config;
 
+// Add .env contents to your environment - see documentation for recomendations
+
 $airtableClient = new AirtableClient(Config::fromEnvironment(), <your_baseid>);
 $table = $airtableClient->getTable(<your_table_name>);
 ```

docs/connection.md

@@ -4,14 +4,55 @@ permalink: /connection.html
 
 ## Connection/Client() usage example
 
-``` php
+There are two supported methods for credential handling in this SDK. The `ENV method`, and the `dependency injection method`. Both are shown below.
+
+### The ENV Method (recommended)
+
+Copy the file `.env.default` to `.env`, and update as needed.
+
+In your code include the [Vlucas/phpdotenv](https://packagist.org/packages/vlucas/phpdotenv) package using `composer`, or another installation method provided by the package. (Composer recommended)
+
+In your code you would use this package to load the contents of the `.env` file like so:
+
+```php
 require_once('vendor/autoload.php');
 
 use Beachcasts\Airtable\AirtableClient;
 use Beachcasts\Airtable\Config;
 
+Dotenv\Dotenv::createImmutable(__DIR__)->load();
+
 $airtableClient = new AirtableClient(Config::fromEnvironment(), <your_baseid>);
+
 $table = $airtableClient->getTable(<your_table_name>);
 ```
 
-NOTE: Update `<your_baseid>` and `<your_table_name>` as needed.
+Then, you can continue using the `Table` object as desired for CRUD+L actions.
+
+### The Dependency Injection Method
+
+Using this method is done by calling a different method in the `Config`, as it is being instantiated. Example:
+
+```php
+require_once('vendor/autoload.php');
+
+use Beachcasts\Airtable\AirtableClient;
+use Beachcasts\Airtable\Config;
+
+$airtableClient = new AirtableClient(
+    Config::fromValues(
+        string $baseUrl,
+        string $version,
+        string $apiKey
+    ),
+    <your_baseid>
+);
+
+$table = $airtableClient->getTable(<your_table_name>);
+```
+
+Then, you can continue using the `Table` object as desired for CRUD+L actions.
+
+## Next Steps
+
+After handling connection with the `AirtableClient`, you are ready to use the SDK to handle any CRUD+L actions. Please refer to the sidebar for navigation, as desired.

docs/create.md

@@ -5,9 +5,6 @@ permalink: /create.html
 ## Create() method usage
 
 ```php
-<?php
-
-// example usage file
 require_once('../vendor/autoload.php');
 
 use Beachcasts\Airtable\AirtableClient;

docs/delete.md

@@ -5,9 +5,6 @@ permalink: /delete.html
 ## Delete() method usage
 
 ```php
-<?php
-
-// example usage file
 require_once('../vendor/autoload.php');
 
 use Beachcasts\Airtable\AirtableClient;

docs/index.md

@@ -4,8 +4,12 @@ permalink: /index.html
 
 ##Welcome to the Beachcasts Airtable SDK Documention
 
-This documentation is a work-in-progress. But links to examples of each method usage can be found below:
+The purpose of this project is to make using the Airtable API as simple as possible. Also, it enables PHP developers to use current conventions to interact with the REST style API at Airtable. This is done by including the GuzzleHttp package to abstract the cURL usage, and facilitate PSR-7 standards if your application uses it. However, you are not forced to comply with PSR-7 if so desired because it happens internally for the SDK.
 
+This documentation is a work-in-progress. But the links will get you going quickly:
+
+* [Getting Started](start.html)
+* [Client Connection](connection.html)
 * [Create](create.html)
 * [Read](read.html)
 * [Update](update.html)

docs/list.md

@@ -5,9 +5,6 @@ permalink: /list.html
 ## List() method usage
 
 ```php
-<?php
-
-// example usage file
 require_once('../vendor/autoload.php');
 
 use Beachcasts\Airtable\AirtableClient;

docs/read.md

@@ -5,9 +5,6 @@ permalink: /read.html
 ## Read method usage
 
 ```php
-<?php
-
-// example usage file
 require_once('../vendor/autoload.php');
 
 use Beachcasts\Airtable\AirtableClient;

docs/replace.md

@@ -5,9 +5,6 @@ permalink: /replace.html
 ## Replace usages
 
 ```php
-<?php
-
-// example usage file
 require_once('../vendor/autoload.php');
 
 use Beachcasts\Airtable\AirtableClient;

docs/start.md

@@ -0,0 +1,38 @@
+---
+permalink: /start.html
+---
+
+## Getting Started
+
+The first think you will need to do it create an [Airtable](https://airtable.com) account.
+
+At the time of this writing, the Airtable API doesn't include functionality for creating a `Base`. Therefore, this SDK assumes you have already created a `Base` using the Airtable.com web-based gui.
+
+Likewise, the Airtable API doesn't support the creation of a `Table` within the `Base`. Nor does it have functionality to create a `View` within a `Table`. So you will need to get your structure in place prior to using the API, or this SDK.
+
+If Airtable adds this support to the API in the future, please let us know, so we can add it to the SDK.
+
+## Installation
+
+We recommend you install this SDK using [Composer](https://getcomposer.org). This allows dependencies to be easily loaded, and also enables PSR-4 style autoloading of the classes.
+
+### Prerequisites
+
+* [Composer](https://getcomposer.org) installed globally
+* PHP v7.2+
+
+### The Install
+
+Using the terminal of your choice, issue the following command from within your application. (The command below assumes Linux OS.)
+
+``` bash
+$ composer require beachcasts/airtable-sdk-php
+```
+
+### Configuration
+
+After installation, there are some configuration choices to make. We recommend you store credentials in the `environment` by loading the `.env` file using something like [Vlucas/phpdotenv](https://packagist.org/packages/vlucas/phpdotenv). However, you can just as easily inject the credentials into the AirtableClient on instantiation.
+
+## Next Steps
+
+Please use any of the links in the sidebar, or continue to [Connection](connection.html).

docs/update.md

@@ -5,9 +5,6 @@ permalink: /update.html
 ## Update() method usage
 
 ```php
-<?php
-
-// example usage file
 require_once('../vendor/autoload.php');
 
 use Beachcasts\Airtable\AirtableClient;