Skip to content

Commit

Permalink
docs: bruch up readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
zaq1tomo authored and jomei committed Jun 5, 2023
1 parent f5fa1b2 commit 4401314
Showing 1 changed file with 20 additions and 15 deletions.
35 changes: 20 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,42 @@
# notionapi

[![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/jomei/notionapi?label=go%20module)](https://github.com/jomei/notionapi/tags)
[![Go Reference](https://pkg.go.dev/badge/github.com/jomei/notionapi.svg)](https://pkg.go.dev/github.com/jomei/notionapi)
[![Test](https://github.com/jomei/notionapi/actions/workflows/test.yml/badge.svg)](https://github.com/jomei/notionapi/actions/workflows/test.yml)

An API client for the [Notion API](https://developers.notion.com/) implemented in Golang
This is a Golang implementation of an API client for the [Notion API](https://developers.notion.com/).

# Supported APIs
It supports all APIs for Notion API version `2022-06-28`
## Supported APIs

# Installation
It supports all APIs of the Notion API version `2022-06-28`.

## Installation

```bash
go get github.com/jomei/notionapi
```
$ go get github.com/jomei/notionapi
```

# Getting started
Follow Notion’s [getting started guide](https://developers.notion.com/docs/getting-started) to obtain an Integration Token.
## Usage

First, please follow the [Getting Started Guide](https://developers.notion.com/docs/getting-started) to obtain an integration token.

## Example
### Initialization

Make a new `Client`
Import this library and initialize the API client using the obtained integration token.

```go
import "github.com/jomei/notionapi"


client := notionapi.NewClient("your-integration-token")
client := notionapi.NewClient("your_integration_token")
```
Then, use client's methods to retrieve or update your content

### Calling the API

You can use the methods of the initialized client to call the Notion API. Here is an example of how to retrieve a page:

```go
page, err := client.Page.Get(context.Background(), "your-page-id")
page, err := client.Page.Get(context.Background(), "your_page_id")
if err != nil {
// do something
// Handle the error
}
```

0 comments on commit 4401314

Please sign in to comment.