diff --git a/README.md b/README.md index b43fa43..5afc6ce 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ Notion Board ## Introduction This action lets you sync your GitHub issue with your notion board. Currently it syncs issue state and labels. -> More feature on the way. +> More features on the way. ## Inputs @@ -26,7 +26,7 @@ This action lets you sync your GitHub issue with your notion board. Currently it |-----|-----------|--------| |`NOTION_API_KEY`|your notion api key|`true`| |`NOTION_DATABASE`|your notion database id|`true`| -|`GITHUB_TOKEN`|your github token|`true`| +|`GITHUB_TOKEN`|your github token|`true`| (automatically created) ## Usage ```yml @@ -40,18 +40,22 @@ jobs: steps: - uses: actions/checkout@v2 - name: Notion Board - uses: Souvikns/Notion-Board@v1.0.0 + uses: Souvikns/Notion-Board@1.0.0 env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} NOTION_API_KEY: ${{ secrets.NOTION_API_KEY }} NOTION_DATABASE: ${{ secrets.NOTION_DATABASE }} ``` -As of now notion API does not allow creating or changing properties, so right now you have to add these properties manually to use this action. +Start with [setting up an integration and sharing your Notion database](https://developers.notion.com/docs/getting-started) with the integration. + +After setting up your workflow, add your `NOTION_API_KEY` and `NOTION_DATABASE` secrets to your repository. + +As of right now notion API does not allow creating or changing properties, meaning you have to **add these properties manually** to your database in order to use this action. - URL - type: `URL` - id - type: `Number` - state - type: `Select` -- labels - type: `Mutli-Select` +- labels - type: `Multi-Select` ## Screenshot ![board](./screenshots/notion-board.PNG)