Skip to content

Update copy of readme #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 15, 2021
Merged

Update copy of readme #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 6 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,7 @@

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

5amcode proudly presents its first Laravel specific package - a wrapper for the Notion API!
This package will provide a simple and crisp way to access the various Notion API endpoints, query data and manipulate
entries.

### Important note!

This package is in an early stage and receives continuious improvements. DO NOT USE IN PRODUCTION.
This package provides a simple and crisp way to access the Notion API endpoints, query data and update existing entries.

## Installation

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

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

Add a new entry to your `.env` like the following:
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.

Add your Notion API token to your `.env` file:

```
NOTION_API_TOKEN="$YOUR_ACCESS_TOKEN"
```

And you're ready to go!

## Usage

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).
Head over to the [Documentation](https://www.notion.so/5amcode/Working-Examples-813998dab4244158b51ea3b25b420c60) of this package in Notion.

### Testing

Expand Down