bunki 0.1.0 → 0.1.1

package/README.md

@@ -19,6 +19,17 @@ Bunki is an opinionated static site generator built with Bun. It's designed for
 
 ## Installation
 
+> **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
+
+# Verify Bun version (should be 1.2.11 or later)
+bun --version
+```
+
 ### From npm (Coming soon)
 ```bash
 # Install globally
@@ -214,7 +225,7 @@ Options:
 
 ## Programmatic Usage
 
-You can also use Bunki programmatically in your own Node.js or Bun scripts:
+You can also use Bunki programmatically in your own Bun scripts:
 
 ```javascript
 import { SiteGenerator, loadConfig } from 'bunki';
@@ -241,6 +252,63 @@ async function generate() {
 generate().catch(console.error);
 ```
 
+> **Note**: Bunki's programmatic API is designed specifically for Bun and utilizes Bun's native APIs for optimal performance. It will not work in Node.js environments.
+
+## Development
+
+### Testing
+
+Bunki includes a comprehensive test suite to verify functionality:
+
+```bash
+# Run all tests
+bun test
+
+# Run specific test files
+bun test site-generator
+bun test utils/markdown
+
+# Run tests with watch mode
+bun test --watch
+
+# Run tests with coverage
+bun test --coverage
+```
+
+Tests are written using Bun's native test runner and verify all core functionality of Bunki, including:
+
+- Site generation process
+- Markdown parsing and rendering
+- Configuration handling
+- File system utilities
+- Template rendering
+
+### Test Fixtures
+
+Bunki comes with a set of test fixtures that are used by the test suite and can also serve as examples:
+
+The fixture directory includes:
+
+```
+fixtures/
+├── bunki.config.json   # Test configuration file
+├── content/            # Sample markdown content
+│   └── 2024/           
+│       ├── test-post-1.md
+│       ├── performance-optimization.md
+│       └── migrating-from-gatsby.md
+├── src/
+│   └── tags.toml       # Tag definitions
+└── templates/          # Test templates
+    ├── base.njk
+    ├── index.njk
+    ├── post.njk
+    └── styles/
+        └── main.css
+```
+
+You can use these fixtures as examples for your own Bunki projects.
+
 ## License
 
 MIT