Skip to content

Commit

Permalink
docs: update README to clarify package functionality and implementati…
Browse files Browse the repository at this point in the history
…on 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.
  • Loading branch information
atxtechbro committed Dec 22, 2024
1 parent 9865a8e commit 3f87de3
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -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

0 comments on commit 3f87de3

Please sign in to comment.