Adding initial README files.

This commit is contained in:
2025-09-25 11:38:05 -04:00
parent 54dc751dca
commit c5c433edb5
3 changed files with 140 additions and 5 deletions

View File

@ -1,7 +1,28 @@
# Tavern
A blogging system that will allow you to write your blog in Markdown and then
display it in HTML using Dioxus.
Tavern is the core content engine of the Tavernworks blog system.
It provides the data model, parsing logic, and database interaction necessary
to convert a Markdown-based blog repository into a structured, queryable form.
## Features
- Parses blog content from Markdown files and metadata.
- Converts content into an in-memory model or stores it in SQLite.
- Provides an async API to query and manipulate blog data.
- Designed to be extensible and integrated into CLI tools or frontends.
## Usage
As a library, `tavern` can be embedded in Rust applications or CLI tools
to handle blog content processing and storage.
```rust
use tavern::{Tavern, Database};
let tavern = Tavern::from_config_file("Tavern.toml");
let database = Database::open("blog.db").await?;
database.insert_tavern(&tavern).await?;
```
---