Skip to content

Commit 0e8cde1

Browse files
committed
updated readme 🥳
1 parent 58281c8 commit 0e8cde1

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

‎README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
<div style="text-align:center">
22

33
# Laravel Notion API
4+
## Effortless Notion integrations with Laravel
5+
46

57
[![Latest Version on Packagist](https://img.shields.io/packagist/v/fiveam-code/laravel-notion-api.svg?style=flat-square)](https://packagist.org/packages/fiveam-code/laravel-notion-api)
68
[![Total Downloads](https://img.shields.io/packagist/dt/fiveam-code/laravel-notion-api.svg?style=flat-square)](https://packagist.org/packages/fiveam-code/laravel-notion-api)
@@ -11,6 +13,13 @@
1113

1214
</div>
1315

16+
5amcode proudly presents its first Laravel specific package - a wrapper for the Notion API!
17+
This package will provide a simple and crisp way to access the various Notion API endpoints, query data
18+
and manipulate entries.
19+
20+
### Important note!
21+
This package is in an early stage and receives continuious improvements. DO NOT USE IN PRODUCTION.
22+
1423
## Installation
1524

1625
You can install the package via composer:
@@ -19,6 +28,16 @@ You can install the package via composer:
1928
composer require fiveam-code/laravel-notion-api
2029
```
2130

31+
Get your Notion API access token like explained in [their documentation](https://developers.notion.com/).
32+
It's also important to grant access to the integration within your Notion pages, which is described in Notions docs as well.
33+
34+
Add a new entry to your `.env` like the following:
35+
```
36+
NOTION_API_TOKEN="$YOUR_ACCESS_TOKEN"
37+
```
38+
39+
And you're ready to go!
40+
2241
## Usage
2342
It's too early for a documentation, so we collected some working examples in our [Notion Workspace](https://www.notion.so/5amcode/Working-Examples-813998dab4244158b51ea3b25b420c60).
2443

0 commit comments

Comments
 (0)