Update documentation

Author: jsiefer

README.md

@@ -1,2 +1,102 @@
+
+<p align="center"><img src="https://static.typeset.sh/images/typeset.sh-logo.svg" width="300"></p>
+
+
 # Typeset.sh wrapper for laravel 7
 
+This is a laravel 7 typeset.sh wrapper that lets you easily configure and use typeset.sh
+in your laravel project.
+
+
+## Installation
+
+Make sure you have access to a valid composer token from typeset.sh.
+
+Add typeset.sh packages repository to composer.
+
+    composer config repositories.typesetsh composer https://packages.typeset.sh
+    composer require typesetsh/laravel-wrapper
+
+
+Then add the following line to register provider in `config/app.php`
+```php
+'providers' => [
+
+    // ...
+    
+    App\Providers\AppServiceProvider::class,
+    App\Providers\AuthServiceProvider::class,
+    App\Providers\EventServiceProvider::class,
+    App\Providers\RouteServiceProvider::class,
+[+] Typesetsh\LaravelWrapper\ServiceProvider::class,
+
+],
+```  
+    
+    
+## Usage
+
+The wrapper works similar to the view. Technically it wraps the view and uses its html output
+and renders it as pdf.
+
+### Facade
+
+You can use the facade pattern. Similar as you would render a view.
+
+```php
+use Typesetsh\LaravelWrapper\Facades\Pdf;
+
+Route::get('/invoice/print', function () {
+    $invoice = new stdClass();
+    
+    return Pdf::make('invoice', ['invoice' => $invoice]);
+});
+```
+
+
+### Helper
+
+Alternative you can use the helper.
+
+```php
+use Typesetsh\LaravelWrapper\Facades\Pdf;
+
+Route::get('/invoice/print', function () {
+    $invoice = new stdClass();
+    
+    return typesetsh\pdf('invoice', ['invoice' => $invoice]);
+});
+```
+
+or force a download
+
+```php
+use Typesetsh\LaravelWrapper\Facades\Pdf;
+
+Route::get('/invoice/print', function () {
+    $invoice = new stdClass();
+    
+    return typesetsh\pdf('invoice', ['invoice' => $invoice])->forceDownload('invoice.pdf');
+});
+```
+
+
+## Configuration
+
+Typeset.sh does not require much configuration. The only important aspect to understand is that
+by default typeset.sh does not allow including any external resources (image, css, fonts,...) 
+unless specified.
+
+See the configuration file `config/typesetsh.php` for more information. By default, typeset.sh
+has access to the public directory and any http(s) resources.
+
+You can also publish the file using:
+
+    php artisan vendor:publish --provider="Typesetsh\LaravelWrapper\ServiceProvider"
+    
+    
+## License
+
+This extension is under the [MIT license](LICENSE).
+
+However, it requires a version of [typeset.sh](https://typeset.sh/) to work.

config/typesetsh.php

@@ -1,11 +1,52 @@
 <?php
 
 return [
+    /*
+    |--------------------------------------------------------------------------
+    | Allowed directories
+    |--------------------------------------------------------------------------
+    |
+    | You must list all directories that typeset.sh can use to load
+    | resources such as images, css or font files.
+    | By default only the public directory is allowed.
+    |
+    */
+
     'allowed_directories' => [public_path()],
 
+    /*
+    |--------------------------------------------------------------------------
+    | Allowed protocols for downloading
+    |--------------------------------------------------------------------------
+    |
+    | You can prevent downloading any resource from the web or add additional
+    | protocols if they are supported by curl.
+    |
+    */
+
     'allowed_protocols' => ['http', 'https'],
 
+    /*
+    |--------------------------------------------------------------------------
+    | Cache directory
+    |--------------------------------------------------------------------------
+    |
+    | Used when downloading resources (images, css, fonts,...) from a remote
+    | location.
+    |
+    */
+
     'cache_dir' => storage_path('framework/cache/typesetsh'),
 
+    /*
+    |--------------------------------------------------------------------------
+    | Timeout
+    |--------------------------------------------------------------------------
+    |
+    | Max timeout when downloading remote resources. Only works when ext-curl
+    | is available.
+    |
+    */
+
     'timeout' => 15,
 ];

src/Pdf/View.php

@@ -37,9 +37,11 @@ public function __construct(HtmlView $view, Typesetsh $pdf)
         $this->pdf = $pdf;
     }
 
-    public function forceDownload(string $filename): void
+    public function forceDownload(string $filename): self
     {
         $this->filename = $filename;
+
+        return $this;
     }
 
     public function render(): string

src/ServiceProvider.php

@@ -26,6 +26,13 @@ public function register()
         $this->registerPdfRenderer();
     }
 
+    public function boot()
+    {
+        $this->publishes([
+            self::CONFIG_PATH => base_path('config/typesetsh.php'),
+        ]);
+    }
+
     protected function registerPdfRenderer(): void
     {
         $this->app->singleton('typesetsh', function ($app) {