Merge pull request #5 from tattersoftware/release

Release Prep

Author: MGatner

README.md

@@ -5,3 +5,70 @@ Persistent user-specific settings for CodeIgniter 4
 [![](https://github.com/tattersoftware/codeigniter4-preferences/workflows/PHPStan/badge.svg)](https://github.com/tattersoftware/codeigniter4-preferences/actions/workflows/analyze.yml)
 [![](https://github.com/tattersoftware/codeigniter4-preferences/workflows/Deptrac/badge.svg)](https://github.com/tattersoftware/codeigniter4-preferences/actions/workflows/inspect.yml)
 [![Coverage Status](https://coveralls.io/repos/github/tattersoftware/codeigniter4-preferences/badge.svg?branch=develop)](https://coveralls.io/github/tattersoftware/codeigniter4-preferences?branch=develop)
+
+## Quick Start
+
+1. Install with Composer: `> composer require --dev tatter/preferences`
+2. Load the helper: `helper('preferences');`
+3. Use the function to get and set: `$theme = preference('theme'); preference('theme', 'dark');`
+
+## Description
+
+`Preferences` is a wrapper for [CodeIgniter Settings](https://github.com/codeigniter4/settings)
+to provide authenticated user context to each setting. This allows you to get and set preferences
+on a per-user basis with a single command.
+
+## Installation
+
+Install easily via Composer to take advantage of CodeIgniter 4's autoloading capabilities
+and always be up-to-date:
+* `> composer require tatter/preferences`
+
+Or, install manually by downloading the source files and adding the directory to
+`app/Config/Autoload.php`.
+
+Once the files are downloaded and included in the autoload, run any library migrations
+to ensure the database is set up correctly:
+* `> php spark migrate -all`
+
+`Preferences` requires the Composer provision for `codeigniter4/authentication-implementation` as describe in the
+[CodeIgniter authentication guidelines](https://codeigniter4.github.io/CodeIgniter4/extending/authentication.html),
+so be sure to install a [supported package](https://packagist.org/providers/codeigniter4/authentication-implementation)
+as well.
+
+## Usage
+
+`Preferences` requires [CodeIgniter Settings](https://github.com/codeigniter4/settings) so
+you may use all the same classes and functions described in its documentation as well. To
+access the user-specific context settings call the `preference()` function anywhere you would
+normally use `setting()`:
+
+```php
+class Home extends Controller
+{
+    public function index()
+    {
+        return view('welcome', [
+            'theme' => preference('theme'),
+        ];
+    }
+
+    public function update_theme()
+    {
+        if ($theme = $this->request->getPost('theme')) {
+            prefernece('theme', $theme);
+        }
+
+        return redirect()->back();
+    }
+}
+```
+
+> Note: Be sure to load the helper file (`helper('preferences')`) before using the helper function.
+
+## Troubleshooting
+
+`Preferences` is a very "thin" library conjoining `Settings` and your authentication library
+of choice. Most likely any issues are related to one of the underlying libraries and should
+be directed there, but if you believe there is a problem or a feature request appropriate to
+this repository then feel free to open an Issue or Pull Request.