Skip to content

Commit 644bcb6

Browse files
committed
update copy of readme
1 parent 37c6ce0 commit 644bcb6

File tree

1 file changed

+6
-14
lines changed

1 file changed

+6
-14
lines changed

README.md

Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,7 @@
1010

1111
[comment]: <> (![GitHub Actions]&#40;https://github.com/fiveam-code/laravel-notion-api/actions/workflows/main.yml/badge.svg&#41;)
1212

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

2115
## Installation
2216

@@ -26,21 +20,19 @@ You can install the package via composer:
2620
composer require fiveam-code/laravel-notion-api
2721
```
2822

29-
Get your Notion API access token like explained in [their documentation](https://developers.notion.com/). It's also
30-
important to grant access to the integration within your Notion pages, which is described in Notions docs as well.
23+
### Authorization
3124

32-
Add a new entry to your `.env` like the following:
25+
The Notion API requires an access token and a Notion integration, [the Notion documentation](https://developers.notion.com/docs/getting-started#before-we-begin) explains how this works. It's important to grant access to the integration within your Notion account to enable the API access.
26+
27+
Add your Notion API token to your `.env` file:
3328

3429
```
3530
NOTION_API_TOKEN="$YOUR_ACCESS_TOKEN"
3631
```
3732

38-
And you're ready to go!
39-
4033
## Usage
4134

42-
It's too early for a documentation, so we collected some working examples in
43-
our [Notion Workspace](https://www.notion.so/5amcode/Working-Examples-813998dab4244158b51ea3b25b420c60).
35+
Head over to the [Documentation](https://www.notion.so/5amcode/Working-Examples-813998dab4244158b51ea3b25b420c60) of this package in Notion.
4436

4537
### Testing
4638

0 commit comments

Comments
 (0)