gatsby-source-notion-churnotion 1.0.0 → 1.0.1

package/README.md

@@ -1,3 +1,89 @@
-# plugin
+# gatsby-source-notion-churnotion
 
-The main focus of the overall tutorial. This contains the whole source plugin.
+Gatsby plugin to connect with a Notion database recursively using the official API.
+
+This plugin recursively collects categories from a single Notion database, which can be used as a CMS for your blog. It ultimately creates a Churnotion node that converts the components of a Notion page into MDX components and stores them in JSON format.
+
+If you're considering Notion as your CMS for Gatsby, this plugin could be a great choice as it supports recursive category collection.
+
+## Install
+
+```shell
+npm install gatsby-source-notion-churnotion
+```
+
+```shell
+yarn add gatsby-source-notion-churnotion
+```
+
+## How to use
+You need to set the following environment variables:
+
+GATSBY_INTEGRATION_TOKEN
+GATSBY_DATABASE_ID
+To get the integration token, set it up in your Notion database, and find the database ID, refer to the official [Notion Integration Guide](https://developers.notion.com/docs/create-a-notion-integration).
+### 환경변수 설정
+```.env:title=.env
+GATSBY_INTEGRATION_TOKEN={Your Notion API Integration Token}
+GATSBY_DATABASE_ID={Your Notion Database ID}
+```
+
+### gatsby-config.ts / gatsby-config.js 추가
+
+```ts:title=gatsby-config.ts
+const config: GatsbyConfig = {
+  plugins: [
+    {
+      resolve: `gatsby-source-notion-churnotion`,
+      options: {
+        token: process.env.GATSBY_INTEGRATION_TOKEN,
+        databaseId: process.env.GATSBY_DATABASE_ID,
+      },
+    },
+  ],
+};
+```
+
+### Run Development Server
+```shell
+npm run develop
+```
+
+```shell
+yarn develop
+```
+
+```shell
+gatsby develop
+```
+
+When the development server is running, `gatsby-source-notion-churnotion` will fetch categories and pages from your Notion database using the official Notion API.
+
+
+![alt text](readme1.png)
+
+### Explore in GraphQL
+
+Once the data is fetched, go to http://localhost:8000/__graphql, where you’ll find new nodes such as `Churnotion`, `NBook`, `NCategory`, and `NTag` as shown below:
+
+![alt text](readme2.png)
+
+### Example Query
+
+Use the following GraphQL query to explore the `Churnotion` node:
+
+```gql
+query MyQuery {
+  allChurnotion {
+    nodes {
+      id
+      content
+    }
+  }
+}
+```
+
+This will return results in MDX format, as shown below:
+
+
+![alt text](readme3.png)

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "gatsby-source-notion-churnotion",
   "description": "Gatsby plugin that can connect with One Notion Database RECURSIVELY using official API",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "skipLibCheck": true,
   "license": "0BSD",
   "main": "./dist/gatsby-node.js",
@@ -24,7 +24,7 @@
     "recursive"
   ],
   "author": "Churnobyl <tjdcjfals3@naver.com> (https://github.com/Churnobyl)",
-  "homepage": "https://github.com/Churnobyl/gatsby-source-notion-churnotion",
+  "homepage": "https://churnobyl.com",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/Churnobyl/gatsby-source-notion-churnotion"