Add documentation

README.md

@@ -0,0 +1,53 @@
+# PHP GitHub Status API
+
+This package provides a way to programmatically determine if GitHub is working 
+well, or experiencing issues.
+Both the current status and historical statuses can be looked up by date.
+
+## Installation
+
+To install PHP GitHub Status API, just run the following composer command.
+
+```bash
+composer require divineomega/github-status-api
+```
+
+Remember to include the `vendor/autoload.php` file if your framework does not 
+do this for you.
+
+## Usage
+
+To check the state of GitHub currently, simply create a new `Client` object,
+and call its `status` method. You can optionally pass a `Carbon` date object
+to the `status` method to retrieve a historical status.
+
+```php
+use DivineOmega\GitHubStatusApi\Client;
+use DivineOmega\GitHubStatusApi\Enums\GitHubStatus;
+
+require_once 'vendor/autoload.php';
+
+$status    = (new Client())->status();
+// $status = (new Client())->status(Carbon::parse('2018-12-06 17:00'));
+
+switch ($status) {
+    case GitHubStatus::GOOD:
+        echo 'GitHub is up! No issues reported.';
+        break;
+
+    case GitHubStatus::MINOR:
+        echo 'GitHub is experiencing minor issues.';
+        break;
+
+    case GitHubStatus::MAJOR:
+        echo 'GitHub is experiencing major issues.';
+        break;
+
+    case GitHubStatus::UNKNOWN:
+        echo 'Unable to determine GitHub\'s status.';
+        break;
+}
+
+echo PHP_EOL;
+
+```