docs: adding some info to readme

README.md

@@ -11,38 +11,200 @@ Seamlessly integrate Polar.sh subscriptions and payments into your Laravel appli
 
 ## Installation
 
-You can install the package via composer:
+**Step 1:** You can install the package via composer:
 
 ```bash
 composer require danestves/laravel-polar
 ```
 
-You can publish and run the migrations with:
+**Step 2:** Publish and run the migrations with:
 
 ```bash
 php artisan vendor:publish --tag="laravel-polar-migrations"
 php artisan migrate
 ```
 
-You can publish the config file with:
+**Step 3:** You can publish the config file with:
 
 ```bash
 php artisan vendor:publish --tag="laravel-polar-config"
 ```
 
 This is the contents of the published config file:
 
-> TBD
+```php
+<?php
+
+return [
+    /*
+    |--------------------------------------------------------------------------
+    | Polar Access Token
+    |--------------------------------------------------------------------------
+    |
+    | The Polar access token is used to authenticate with the Polar API.
+    | You can find your access token in the Polar dashboard > Settings
+    | under the "Developers" section.
+    |
+    */
+    'access_token' => env('POLAR_ACCESS_TOKEN'),
+
+    /*
+    |--------------------------------------------------------------------------
+    | Polar Webhook Secret
+    |--------------------------------------------------------------------------
+    |
+    | The Polar webhook secret is used to verify that the webhook requests
+    | are coming from Polar. You can find your webhook secret in the Polar
+    | dashboard > Settings > Webhooks on each registered webhook.
+    |
+    | We (the developers) recommend using a single webhook for all your
+    | integrations. This way you can use the same secret for all your
+    | integrations and you don't have to manage multiple webhooks.
+    |
+    */
+    'webhook_secret' => env('POLAR_WEBHOOK_SECRET'),
+
+    /*
+    |--------------------------------------------------------------------------
+    | Polar Url Path
+    |--------------------------------------------------------------------------
+    |
+    | This is the base URI where routes from Polar will be served
+    | from. The URL built into Polar is used by default; however,
+    | you can modify this path as you see fit for your application.
+    |
+    */
+    'path' => env('POLAR_PATH', 'polar'),
+
+    /*
+    |--------------------------------------------------------------------------
+    | Default Redirect URL
+    |--------------------------------------------------------------------------
+    |
+    | This is the default redirect URL that will be used when a customer
+    | is redirected back to your application after completing a purchase
+    | from a checkout session in your Polar account.
+    |
+    */
+    'redirect_url' => null,
+
+    /*
+    |--------------------------------------------------------------------------
+    | Currency Locale
+    |--------------------------------------------------------------------------
+    |
+    | This is the default locale in which your money values are formatted in
+    | for display. To utilize other locales besides the default "en" locale
+    | verify you have to have the "intl" PHP extension installed on the system.
+    |
+    */
+    'currency_locale' => env('POLAR_CURRENCY_LOCALE', 'en'),
+];
+```
 
-Optionally, you can publish the views using
+**Step 4:** Optionally, you can publish the views using:
 
 ```bash
 php artisan vendor:publish --tag="laravel-polar-views"
 ```
 
 ## Usage
 
-> TBD
+### Access Token
+
+Configure your access token. Create a new token in the Polar Dashboard > Settings > Developers and paste it in the `.env` file.
+
+- https://sandbox.polar.sh/dashboard/<org_slug>/settings (Sandbox)
+- https://polar.sh/dashboard/<org_slug>/settings (Production)
+
+```bash
+POLAR_ACCESS_TOKEN="<your_access_token>"
+```
+
+### Webhook Secret
+
+Configure your webhook secret. Create a new webhook in the Polar Dashboard > Settings > Webhooks.
+
+- https://sandbox.polar.sh/dashboard/<org_slug>/settings/webhooks (Sandbox)
+- https://polar.sh/dashboard/<org_slug>/settings/webhooks (Production)
+
+Configure the webhook for the following events that this pacckage supports:
+
+- `order.created`
+- `order.updated`
+- `subscription.created`
+- `subscription.updated`
+- `subscription.active`
+- `subscription.canceled`
+- `subscription.revoked`
+- `benefit_grant.created`
+- `benefit_grant.updated`
+- `benefit_grant.revoked`
+
+```bash
+POLAR_WEBHOOK_SECRET="<your_webhook_secret>"
+```
+
+### Billable Trait
+
+Let’s make sure everything’s ready for your customers to checkout smoothly. 🛒
+
+First, we’ll need to set up a model to handle billing—don’t worry, it’s super simple! In most cases, this will be your app’s User model. Just add the Billable trait to your model like this (you’ll import it from the package first, of course):
+
+```php
+use Danestves\LaravelPolar\Billable;
+
+class User extends Authenticatable
+{
+    use Billable;
+}
+```
+
+Now the user model will have access to the methods provided by the package. You can make any model billable by adding the trait to it, not just the User model.
+
+### Polar Script
+
+Polar includes a JavaScript script that you can use to initialize the [Polar Embedded Checkout](https://docs.polar.sh/features/checkout/embed). If you going to use this functionality, you can use the `@polar` directive to include the script in your views inside the `<head>` tag.
+
+```blade
+<head>
+    ...
+
+    @polar
+</head>
+```
+
+### Webhooks
+
+This package includes a webhook handler that will handle the webhooks from Polar.
+
+#### Webhooks & CSRF Protection
+
+Incoming webhooks should not be affected by [CSRF protection](https://laravel.com/docs/csrf). To prevent this, add your webhook path to the except list of your `App\Http\Middleware\VerifyCsrfToken` middleware:
+
+```php
+protected $except = [
+    'polar/*',
+];
+```
+
+Or if you're using Laravel v11 and up, you should exclude `polar/*` in your application's `bootstrap/app.php` file:
+
+```php
+->withMiddleware(function (Middleware $middleware) {
+    $middleware->validateCsrfTokens(except: [
+        'polar/*',
+    ]);
+})
+```
+
+### Commands
+
+This package includes a list of commands that you can use to retrieve information about your Polar account.
+
+| Command | Description |
+|---------|-------------|
+| `php artisan polar:products` | List all available products with their ids |
 
 ## Testing
 

config/polar.php

@@ -6,8 +6,9 @@
     | Polar Access Token
     |--------------------------------------------------------------------------
     |
-    | The Polar access token is used to authenticate with the Polar API.You can find your access token in
-    | the Polar dashboard > Settings under the "Developers" section.
+    | The Polar access token is used to authenticate with the Polar API.
+    | You can find your access token in the Polar dashboard > Settings
+    | under the "Developers" section.
     |
     */
     'access_token' => env('POLAR_ACCESS_TOKEN'),

src/LaravelPolarServiceProvider.php

@@ -4,6 +4,7 @@
 
 use Danestves\LaravelPolar\Commands\ListProductsCommand;
 use Danestves\LaravelPolar\View\Components\Button;
+use Illuminate\Support\Facades\Blade;
 use Spatie\LaravelPackageTools\Package;
 use Spatie\LaravelPackageTools\PackageServiceProvider;
 
@@ -13,13 +14,27 @@ public function configurePackage(Package $package): void
     {
         $package
             ->name('laravel-polar')
-            ->hasConfigFile()
-            ->hasViews()
+            ->hasConfigFile("polar")
+            ->hasViews('polar')
             ->hasViewComponent('polar', Button::class)
             ->discoversMigrations()
             ->hasRoute("web")
             ->hasCommands(
                 ListProductsCommand::class,
             );
     }
+
+    public function boot(): void
+    {
+        parent::boot();
+
+        $this->bootDirectives();
+    }
+
+    protected function bootDirectives(): void
+    {
+        Blade::directive('polar', function () {
+            return "<?php echo view('polar::js'); ?>";
+        });
+    }
 }