From 3f87de33ee86cb2feed658ee69eb88af315cbd89 Mon Sep 17 00:00:00 2001 From: Morgan Joyce Date: Sat, 21 Dec 2024 21:50:15 -0600 Subject: [PATCH] docs: update README to clarify package functionality and implementation details - Expanded the description of the Notion Automation package to emphasize its standalone nature and direct API integration. - Added an important note highlighting that this package is not related to the official `notion-client` package. - Included new sections on implementation details and contributing guidelines, outlining the custom client and schema handling features. --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e0abb65..30f6a0f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,13 @@ # Notion Automation -Tool for automating Notion database creation and management using JSON schemas. +A custom implementation for automating Notion database operations. This package provides direct API integration without relying on the official `notion-client` package. + +## Important Note + +This package is a standalone implementation and is **not** related to the official `notion-client` package. We've built our own client to: +- Have more control over the API interactions +- Implement custom schema handling +- Provide simplified database operations ## Setup @@ -100,3 +107,18 @@ Three log levels are used: - ERROR: API errors and exceptions Logs are written to both console and `notion_automation.log` file. + +## Implementation Details + +This package includes: +- Custom Notion API client (`notion_automation.notion_client`) +- Schema validation and parsing +- Database creation and management +- No dependencies on external Notion client libraries + +## Contributing + +When contributing, note that this package: +1. Uses its own Notion API client implementation +2. Does not depend on the official `notion-client` package +3. Handles all API interactions directly