diff --git a/README.md b/README.md new file mode 100644 index 0000000..30a63ad --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ + +# markdown_sqlite.py + +This script processes a markdown file by reading its content and +updates an SQLite database with document content and metadata. +The user can then select specific topics based on command-line arguments. +The script tracks changes using MD5 hashes and ensures the database +reflects the current state of the markdown filarguments + +usage: +$ python3.11 markdown_sqlite.py --bootstrap +$ python3.11 markdown_sqlite.py September +$ nvim calendar.md +$ python3.11 markdown_sqlite.py + +arguments: + -m, --markdown: Path to markdown file (default: 'calendar.md'). + -d, --database: Path to SQLite database file (default: 'markdown.db'). + topic_title: Optional topic for content selection (fuzzy matching enabled). + --bootstrap: If provided, generates markdown calendar for the current year and loads it to the database. + --ls: If provided, lists all available headings.