bunki 0.1.1 → 0.1.3

package/README.md

@@ -2,6 +2,7 @@
 
 [![GitHub license](https://img.shields.io/github/license/kahwee/bunki)](https://github.com/kahwee/bunki/blob/main/LICENSE)
 [![GitHub issues](https://img.shields.io/github/issues/kahwee/bunki)](https://github.com/kahwee/bunki/issues)
+[![Coverage Status](https://coveralls.io/repos/github/kahwee/bunki/badge.svg?branch=main)](https://coveralls.io/github/kahwee/bunki?branch=main)
 
 Bunki is an opinionated static site generator built with Bun. It's designed for creating blogs and simple websites with sensible defaults and minimal configuration.
 
@@ -22,6 +23,7 @@ Bunki is an opinionated static site generator built with Bun. It's designed for
 > **IMPORTANT**: Bunki requires Bun v1.2.11 or later as its runtime. It is not compatible with Node.js and will not work with npm, yarn, or pnpm.
 
 ### Prerequisites
+
 ```bash
 # Install Bun if you don't have it
 curl -fsSL https://bun.sh/install | bash
@@ -31,6 +33,7 @@ bun --version
 ```
 
 ### From npm (Coming soon)
+
 ```bash
 # Install globally
 bun install -g bunki
@@ -40,6 +43,7 @@ bun install bunki
 ```
 
 ### From GitHub
+
 ```bash
 # Clone the repository
 git clone git@github.com:kahwee/bunki.git
@@ -65,6 +69,7 @@ bunki init
 ```
 
 This will:
+
 - Create a default configuration file (`bunki.config.json`)
 - Set up the required directory structure
 - Create default templates
@@ -77,7 +82,7 @@ Create markdown files in the `content` directory with frontmatter:
 ```markdown
 ---
 title: Your Post Title
-date: 2023-01-01T12:00:00Z
+date: 2025-01-01T12:00:00Z
 tags: [tag1, tag2]
 ---
 
@@ -228,25 +233,25 @@ Options:
 You can also use Bunki programmatically in your own Bun scripts:
 
 ```javascript
-import { SiteGenerator, loadConfig } from 'bunki';
-import path from 'path';
+import { SiteGenerator, loadConfig } from "bunki";
+import path from "path";
 
 // Load configuration
-const config = loadConfig('bunki.config.json');
+const config = loadConfig("bunki.config.json");
 
 // Create a generator
 const generator = new SiteGenerator({
-  contentDir: path.join(process.cwd(), 'content'),
-  outputDir: path.join(process.cwd(), 'dist'),
-  templatesDir: path.join(process.cwd(), 'templates'),
-  config
+  contentDir: path.join(process.cwd(), "content"),
+  outputDir: path.join(process.cwd(), "dist"),
+  templatesDir: path.join(process.cwd(), "templates"),
+  config,
 });
 
 // Generate site
 async function generate() {
   await generator.initialize();
   await generator.generate();
-  console.log('Site generation complete!');
+  console.log("Site generation complete!");
 }
 
 generate().catch(console.error);
@@ -272,9 +277,11 @@ bun test utils/markdown
 bun test --watch
 
 # Run tests with coverage
-bun test --coverage
+bun test:coverage
 ```
 
+Code coverage reports are automatically generated and displayed on GitHub through a badge at the top of this README. You can also view detailed coverage reports on [Coveralls](https://coveralls.io/github/kahwee/bunki).
+
 Tests are written using Bun's native test runner and verify all core functionality of Bunki, including:
 
 - Site generation process
@@ -293,7 +300,7 @@ The fixture directory includes:
 fixtures/
 ├── bunki.config.json   # Test configuration file
 ├── content/            # Sample markdown content
-│   └── 2024/           
+│   └── 2025/
 │       ├── test-post-1.md
 │       ├── performance-optimization.md
 │       └── migrating-from-gatsby.md
@@ -311,4 +318,4 @@ You can use these fixtures as examples for your own Bunki projects.
 
 ## License
 
-MIT
+MIT