docs: prep for v1.0 soft release

CHANGELOG.md

@@ -2,6 +2,6 @@
 
 All notable changes to `frontdesk` will be documented in this file
 
-## 1.0.0 - 201X-XX-XX
+## 1.0.0 - 2023-10-24
 
 - initial release

README.md

@@ -4,7 +4,7 @@
 [![Total Downloads](https://img.shields.io/packagist/dt/plank/frontdesk.svg?style=flat-square)](https://packagist.org/packages/plank/frontdesk)
 ![GitHub Actions](https://github.com/plank/frontdesk/actions/workflows/main.yml/badge.svg)
 
-Frontdesk allows you to build a navigation bar using models within your Laravel application easily.
+Frontdesk allows you to build a navigation bar using models within your Laravel application. 
 
 
 ## Installation
@@ -17,8 +17,89 @@ composer require plank/frontdesk
 
 ## Usage
 
+Frontdesk separates the concept of a navigation bar into 2 parts: 
+the `Menu` and the `Hyperlink`. 
+A `Menu` is a collection of `Hyperlink`s. 
+Each `Hyperlink` can have a parent `Hyperlink` and a collection of child `Hyperlink`s. 
+
+To that end you may have content that is "linkable" and content that is "menuable".
+
+To use Frontdesk simply add the traits and implement the corresponding interfaces on your models.
+
+### Linkable
+```php
+
+class MyModel extends Model implements Linkable
+{
+    use IsLinkable;
+
+    public function linkTitle(): Attribute
+    {
+        return Attribute::make(
+            get: fn () => $this->title
+        );
+    }
+
+    public function linkUrl(): Attribute
+    {
+        return Attribute::make(
+            get: fn () => route('my-model.show', $this)
+        );
+    }
+}
+```
+
+### Menuable
+
+```php
+class MyMenuModel extends Model implements Menuable 
+{
+    use HasMenus;
+}
+```
+
+### Saving Menus & Links
+
+Once you have a few models that implement the appropriate interfaces you can start building your navigation bar.
+
+```php
+// Create a menu
+$myMenu = MyMenuModel::find(1)->menus()->create([
+    'identifier' => 'header-nav'
+]); 
+$myOtherMenu = MyMenuModel::find(1)->menus()->create([
+    'identifier' => 'footer-nav'
+]);
+
+// Create a hyperlink referencing 
+$myModelLink = MyModel::find(1)->hyperlinks()->create([
+    'menu_id' => $myMenu->id,
+]);
+
+// A link also doesn't strictly need to be attached to a model
+$myMenuLink = Hyperlink::create([
+    'menu_id' => $myMenu->id,
+    'title' => 'My Link',
+    'url' => 'https://example.com',
+]);
+
+// You can also associate an existing hyperlink to an existing menu
+$myMenuLink->menus()->associate($myOtherMenu)->save();
+```
+
+### Getting Menus & Links
+After building a few menus, you can retrieve them using the `Menu` model, or via a model's relation to the `Menu` model.
+```php
+// Get a menu by identifier
+$myMenu = Menu::where('identifier', 'header-nav')->first();
+
+// Via a model relationship
+$myMenu = MyMenuModel::find(1)->menus()->where('identifier', 'header-nav')->first();
+```
+
+Getting links out of the menu is as simple as calling the `hyperlinks` relationship on the `Menu` model.
 ```php
-// Usage description here
+$myMenu->hyperlinks;
 ```
 
 ### Testing
@@ -37,11 +118,12 @@ Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
 
 ### Security
 
-If you discover any security related issues, please email test@example.com instead of using the issue tracker.
+If you discover any security related issues, please email <a href="mailto:security@plankdesign.com">[email protected]</a> instead of using the issue tracker.
 
 ## Credits
 
--   [Massimo Triassi](https://github.com/plank)
+-   [Massimo Triassi](https://github.com/m-triassi)
+-   [Kurt Friars](https://github.com/kfriars)
 -   [All Contributors](../../contributors)
 
 ## License

composer.json

@@ -3,15 +3,22 @@
     "description": "",
     "keywords": [
         "plank",
-        "frontdesk"
+        "frontdesk",
+        "laravel",
+        "navigation"
     ],
     "homepage": "https://github.com/plank/frontdesk",
     "license": "MIT",
     "type": "library",
     "authors": [
         {
             "name": "Massimo Triassi",
-            "email": "[email protected]",
+            "email": "[email protected]",
+            "role": "Developer"
+        },
+        {
+            "name": "Kurt Friars",
+            "email": "[email protected]",
             "role": "Developer"
         }
     ],