Skip to content

Commit 1971a4c

Browse files
committed
Update readme
1 parent 2e327dd commit 1971a4c

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,20 @@ Renders the JSON response of the official Notion API as React components. Stylin
1717

1818
Checkout the [Demo](https://xennis.github.io/react-notion-render/).
1919

20-
## Installation
20+
## Packages
21+
22+
| Package dir | NPM version | Size |
23+
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
24+
| `fetch` | [![NPM version](https://img.shields.io/npm/v/@xennis/react-notion-cms-fetch.svg)](https://www.npmjs.com/package/@xennis/react-notion-cms-fetch) | [![NPM bundle size](https://img.shields.io/bundlephobia/minzip/@xennis/react-notion-cms-fetch.svg)](https://bundlephobia.com/package/@xennis/react-notion-cms-fetch) |
25+
| `render` | [![NPM version](https://img.shields.io/npm/v/@xennis/react-notion-cms-render.svg)](https://www.npmjs.com/package/@xennis/react-notion-cms-render) | [![NPM bundle size](https://img.shields.io/bundlephobia/minzip/@xennis/react-notion-cms-render.svg)](https://bundlephobia.com/package/@xennis/react-notion-cms-render) |
2126

22-
The package is not released yet. Still you can use for example [GitPkg](https://gitpkg.vercel.app/) to install it
23-
(Hint: To pin the version replace `main` by a commit hash)
27+
## Installation
2428

2529
```shell
2630
# Add the render package
27-
npm install 'https://gitpkg.now.sh/Xennis/react-notion-render/packages/render?main&scripts.install=pnpm%20build'
31+
npm install @xennis/react-notion-cms-render
2832
# (Optional) Add the fetch package
29-
npm install 'https://gitpkg.now.sh/Xennis/react-notion-render/packages/fetch?main&scripts.install=pnpm%20build'
33+
npm install @xennis/react-notion-cms-fetch
3034
```
3135

3236
Next, add the package to you Tailwind CSS config:
@@ -38,7 +42,7 @@ const config: Config = {
3842
content: [
3943
"./src/components/**/*.{js,ts,jsx,tsx,mdx}",
4044
"./src/app/**/*.{js,ts,jsx,tsx,mdx}",
41-
+ "./node_modules/@react-notion-cms/render/**/*.{js,jsx}",
45+
+ "./node_modules/@xennis/react-notion-cms-render/**/*.{js,jsx}",
4246
],
4347
}
4448
export default config
@@ -48,8 +52,8 @@ export default config
4852

4953
```tsx
5054
import { Client } from "@notionhq/client"
51-
import { fetchBlocksChildren, Render } from "@react-notion-cms/render"
52-
import "@react-notion-cms/render/dist/styles.css"
55+
import { fetchBlocksChildren, Render } from "@xennis/react-notion-cms-render"
56+
import "@xennis/react-notion-cms-render/dist/styles.css"
5357

5458
const client = new Client({ auth: "<NOTION AUTH TOKEN>" })
5559

0 commit comments

Comments
 (0)