From eb8e7a67943793b470b64730de056d49d23a62d5 Mon Sep 17 00:00:00 2001
From: Faruk Nasir <frknasir@yahoo.com>
Date: Thu, 13 Jul 2023 23:27:23 +0100
Subject: [PATCH] chore: updated readme

---
 README.md | 62 ++++++++++++++++++++++++++++++++++++++++++++++---------
 1 file changed, 52 insertions(+), 10 deletions(-)

diff --git a/README.md b/README.md
index f329c7b..fa23f9f 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # Introduction
 
-Manage contacts(e.g customers, suppliers, vendors etc) and addresses in your laravel applications.
+Manage contacts(e.g customers, suppliers, vendors etc) in your laravel applications.
 
 ## Installation
 
@@ -8,12 +8,7 @@ You can install the package via composer:
 
 ```bash
 composer require starfolksoftware/ally
-```
-
-You can publish and run the migrations with:
-
-```bash
-php artisan vendor:publish --tag="ally-migrations"
+php artisan Ally:install
 php artisan migrate
 ```
 
@@ -23,11 +18,11 @@ You can publish the config file with:
 php artisan vendor:publish --tag="ally-config"
 ```
 
+## Configuration
+
 This is the contents of the published config file:
 
 ```php
-<?php
-// config for StarfolkSoftware/Ally
 return [
     'middleware' => ['web'],
 
@@ -39,10 +34,57 @@ return [
 ];
 ```
 
+Optionally, you can publish the views using
+
+```bash
+php artisan vendor:publish --tag="ally-views"
+```
+
 ## Usage
 
 ```php
+<?php
+
+namespace App\Models;
+
+use App\Abstracts\Model;
+use Ally\HasContacts;
+
+class Product extends Model
+{
+    use HasContacts;
+}
+
+```
+
+To enable team support:
+
+```php
+// this should be in a service provider
+/**
+ * Bootstrap any application services.
+ *
+ * @return void
+ */
+public function boot()
+{
+    Ally::supportsTeams();
+}
+```
+
+```php
+<?php
+
+namespace App\Models;
+
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Ally\TeamHasCategories;
 
+class Team extends JetstreamTeam
+{
+    ...
+    use TeamHasCategories;
+}
 ```
 
 ## Testing
@@ -57,7 +99,7 @@ Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed re
 
 ## Contributing
 
-Please see [CONTRIBUTING](https://github.com/spatie/.github/blob/main/CONTRIBUTING.md) for details.
+Please see [CONTRIBUTING](https://github.com/starfolksoftware/.github/blob/main/CONTRIBUTING.md) for details.
 
 ## Security Vulnerabilities