Skip to content

Commit 0d060f9

Browse files
committed
Update readme
1 parent 913d64a commit 0d060f9

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -85,9 +85,15 @@ export default {
8585
8686
## Examples
8787

88-
These examples use a simple wrapper around the [`notion-api-worker`](https://github.com/splitbee/notion-api-worker).
88+
These examples use a simple wrapper around the [`notion-api-worker`](https://github.com/splitbee/notion-api-worker) to access the Notion page data.
8989
It is also possible to store a page received from the Notion API in `.json` and use it without the `async/await` part.
9090

91+
> Use the `getPageBlocks` and `getPageTable` methods with caution!
92+
> They are based on the private Notion API.
93+
> We can NOT guarantee that it will stay stable.
94+
> The private API is warpped by [notion-api-worker](https://github.com/splitbee/notion-api-worker).
95+
> If you use these methods a lot, please consider hosting you own instance, as described in [`docs#notion-api`](https://github.com/janniks/vue-notion/tree/main/docs#notion-api).
96+
9197
### Basic Example for Vue
9298

9399
This example is a part of [`example/`](https://github.com/janniks/vue-notion/tree/main/example) and is hosted at [vue-notion.now.sh/vue](https://vue-notion.now.sh/vue).
@@ -142,15 +148,9 @@ export default {
142148
</style>
143149
```
144150

145-
> ⚠️ Use with caution!
146-
> The `getPageBlocks` and `getPageTable` are based on the private Notion API.
147-
> We can NOT guarantee that it will stay stable.
148-
> The private API is warpped by [notion-api-worker](https://github.com/splitbee/notion-api-worker).
149-
> If you use these methods a lot, please consider hosting you own instance, as described in [`docs#notion-api`](https://github.com/janniks/vue-notion/tree/main/docs#notion-api).
150-
151-
## Roadmap
151+
## Issues & Roadmap
152152

153-
[Add issues](https://github.com/janniks/vue-notion/issues/new), request features and upvote [block types](https://github.com/janniks/vue-notion/issues?q=is%3Aissue+is%3Aopen+label%3Ablock) that you want to see next!
153+
[Add issues](https://github.com/janniks/vue-notion/issues/new) and request features that you want to see implemented next!
154154

155155
## Sites using vue-notion
156156

0 commit comments

Comments
 (0)