Changing loremaster to loreweaver.
This commit is contained in:
42
loreweaver/README.md
Normal file
42
loreweaver/README.md
Normal file
@ -0,0 +1,42 @@
|
||||
# Loreweaver
|
||||
|
||||
Loreweaver is a command-line tool that compiles a blog repository into a SQLite
|
||||
database using the Tavernworks blog system. It acts as a publisher that reads
|
||||
a metadata configuration file and processes the blog content via the `tavern`
|
||||
engine.
|
||||
|
||||
## Features
|
||||
|
||||
- Reads a `Tavern.toml` metadata file to configure the compilation
|
||||
- Converts Markdown blog repositories into portable SQLite databases
|
||||
- Simple CLI interface with configurable input and output paths
|
||||
- Built on top of the `tavern` library for content parsing and data handling
|
||||
|
||||
## Usage
|
||||
|
||||
Run Loreweaver with the default configuration file and output:
|
||||
|
||||
```bash
|
||||
loreweaver --config Tavern.toml --output tavern.db
|
||||
```
|
||||
|
||||
Specify custom paths for config or output files:
|
||||
|
||||
```bash
|
||||
loreweaver --config path/to/config.toml --output path/to/output.db
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Copyright & License
|
||||
|
||||
Copyright 2025 CyberMages LLC
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this library except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS
|
||||
Reference in New Issue
Block a user