wip

Author: osbre

README.md

@@ -1,78 +1,52 @@
-Please see [this repo](https://github.com/laravel-notification-channels/channels) for instructions on how to submit a channel proposal.
-
-# A Boilerplate repo for contributions
-
-[![Latest Version on Packagist](https://img.shields.io/packagist/v/laravel-notification-channels/:package_name.svg?style=flat-square)](https://packagist.org/packages/laravel-notification-channels/:package_name)
-[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)
-[![Build Status](https://img.shields.io/travis/laravel-notification-channels/:package_name/master.svg?style=flat-square)](https://travis-ci.org/laravel-notification-channels/:package_name)
-[![StyleCI](https://styleci.io/repos/:style_ci_id/shield)](https://styleci.io/repos/:style_ci_id)
-[![SensioLabsInsight](https://img.shields.io/sensiolabs/i/:sensio_labs_id.svg?style=flat-square)](https://insight.sensiolabs.com/projects/:sensio_labs_id)
-[![Quality Score](https://img.shields.io/scrutinizer/g/laravel-notification-channels/:package_name.svg?style=flat-square)](https://scrutinizer-ci.com/g/laravel-notification-channels/:package_name)
-[![Code Coverage](https://img.shields.io/scrutinizer/coverage/g/laravel-notification-channels/:package_name/master.svg?style=flat-square)](https://scrutinizer-ci.com/g/laravel-notification-channels/:package_name/?branch=master)
-[![Total Downloads](https://img.shields.io/packagist/dt/laravel-notification-channels/:package_name.svg?style=flat-square)](https://packagist.org/packages/laravel-notification-channels/:package_name)
-
-This package makes it easy to send notifications using [:service_name](link to service) with Laravel 5.5+, 6.x and 7.x
-
-**Note:** Replace ```Notion``` ```:service_name``` ```:author_name``` ```:author_username``` ```:author_website``` ```:author_email``` ```:package_name``` ```:package_description``` ```:style_ci_id``` ```:sensio_labs_id``` with their correct values in [README.md](README.md), [CHANGELOG.md](CHANGELOG.md), [CONTRIBUTING.md](CONTRIBUTING.md), [LICENSE.md](LICENSE.md), [composer.json](composer.json) and other files, then delete this line.
-**Tip:** Use "Find in Path/Files" in your code editor to find these keywords within the package directory and replace all occurences with your specified term.
-
-This is where your description should go. Add a little code example so build can understand real quick how the package can be used. Try and limit it to a paragraph or two.
-
-
-
-## Contents
-
-- [Installation](#installation)
-	- [Setting up the :service_name service](#setting-up-the-:service_name-service)
-- [Usage](#usage)
-	- [Available Message methods](#available-message-methods)
-- [Changelog](#changelog)
-- [Testing](#testing)
-- [Security](#security)
-- [Contributing](#contributing)
-- [Credits](#credits)
-- [License](#license)
-
-
 ## Installation
 
-Please also include the steps for any third-party service setup that's required for this package.
-
-### Setting up the :service_name service
-
-Optionally include a few steps how users can set up the service.
+```shell
+composer require astroshippers/notion-notification-channel
+```
 
 ## Usage
 
-Some code examples, make it clear how to use the package
+Inside eloquent model:
 
-### Available Message methods
-
-A list of all available options
-
-## Changelog
-
-Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
-
-## Testing
-
-``` bash
-$ composer test
+```php
+public function routeNotificationForNotion(): array
+{
+    return [
+        'token'    => config('services.notion.token'),
+        'database' => '8e12b788392e4367b0532c9abb519133',
+    ];
+}
 ```
 
-## Security
-
-If you discover any security related issues, please email :author_email instead of using the issue tracker.
-
-## Contributing
-
-Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
-
-## Credits
-
-- [:author_name](https://github.com/:author_username)
-- [All Contributors](../../contributors)
-
-## License
-
-The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
+Inside notification class:
+
+```php
+use NotificationChannels\Notion\{NotionChannel, NotionDatabaseItem};
+use NotificationChannels\Notion\Properties\{Checkbox, Email, MultiSelect, Number, RichText, Status, Title, URL};
+
+public function via($notifiable)
+{
+    return [NotionChannel::class];
+}
+
+public function toNotion(User $notifiable): NotionDatabaseItem
+{
+    return NotionDatabaseItem::create()
+        ->properties([
+            'Name'          => Title::make('John Doe'),
+            'Email'         => Email::make('[email protected]'),
+            'SomeNumber'    => Number::make(12345),
+            'Tags'          => MultiSelect::make(['blah', 'blah2', 'blah3']),
+            'True or False' => Checkbox::make(false),
+            'URL'           => URL::make('https://developers.notion.com/reference/property-value-object'),
+            'Some Text'     => RichText::make([
+                [
+                    "type" => "text",
+                    "text" => [
+                        "content" => "Some more text with ",
+                    ]
+                ],
+            ]),
+        ]);
+}
+```

composer.json

@@ -1,13 +1,13 @@
 {
-    "name": "laravel-notification-channels/notion",
-    "description": ":package_description",
+    "name": "astroshippers/notion-notification-channel",
+    "description": "Notion Notifications driver",
     "homepage": "https://github.com/laravel-notification-channels/notion",
     "license": "MIT",
     "authors": [
         {
             "name": "Ostap",
             "email": "[email protected]",
-            "homepage": ":author_website",
+            "homepage": "github.com/osbre",
             "role": "Developer"
         }
     ],