@ainame/tuzuru 0.1.2 → 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Satoshi Namai
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,25 +1,29 @@
 # Tuzuru
 
-![logo](.github/assets/logo.png)
-
-Tuzuru (綴る) is dead-simple static **blog** generator CLI that uses Git to manage your blog's metadata.
-
-Instead of writing YAML front matter, you just write and save your plain Markdown files to Git. Tuzuru automatically pulls metadata like the publication date and author information from the Git commit history.
-
-This means you can focus on what you're writing, not on remembering syntax. It's a simpler, more lightweight way to manage your blog.
-
-## Motivation
+[![Swift Version](https://img.shields.io/badge/Swift-6.1+-blue.svg)](https://swift.org)
+[![Swift Package Manager](https://img.shields.io/badge/SPM-compatible-brightgreen.svg)](https://swift.org/package-manager/)
+[![License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/ainame/tuzuru/blob/main/LICENSE)
+[![GitHub Release](https://img.shields.io/github/v/release/ainame/tuzuru)](https://github.com/ainame/tuzuru/releases)
+[![Build Status](https://img.shields.io/github/actions/workflow/status/ainame/tuzuru/ci.yml?branch=main)](https://github.com/ainame/tuzuru/actions)
 
-Years ago, I built a blog with Hugo, but eventually stopped updating it. When I recently wanted to start again, I found it tough to remember and re-learn how to use it.
+Tuzuru (綴る) is a dead-simple static **blog** generator CLI that uses Git to manage your blog metadata.
+Just write and commit plain Markdown files—no front matter needed.
+Tuzuru automatically derives metadata such as dates and author from your Git history.
 
-I wanted a simple, intuitive blogging tool, but none I tried felt quite right. So, I decided to build my own.
+![logo](.github/assets/logo.png)
 
-Tuzuru is designed with these core principles:
+It is designed to keep workflows minimal, allowing you to focus on writing.
 
-* Plain Markdown: No YAML front matter.
-* Simple Routing: A routing system built specifically for blogs.
-* No JavaScript Framework: Lightweight and fast.
-* Single Binary Installation: Avoids environment setup for tools that you may not use day-to-day
+* Simple plain Markdown format, no YAML required
+  * Instead of YAML front matter, Tuzuru pulls the publication date and author from Git.
+* Simple routing with auto-generated listing pages
+  * Yearly archives and category-based listings are created automatically.
+* Simple preview server with built-in watch mode
+  * `tuzuru serve` automatically rebuilds on requests.
+* Simple installation with minimal setup
+  * Install via Homebrew, npm, or download a binary from GitHub Releases.
+* Simple deployment with built-in GitHub Actions
+  * From installation to deployment, everything is handled for you.
 
 ## Installation
 
@@ -89,14 +93,75 @@ tuzuru serve
 
 This starts a local HTTP server at `http://localhost:8000` with auto-regeneration enabled. When you modify source files, the blog will be automatically rebuilt on the next request.
 
+### Deployment
+
+This repo has two GitHub Actions prepared for Tuzuru blogs to set up deployment easily.
+
+* [ainame/Tuzuru/.github/actions/tuzuru-deploy](https://github.com/ainame/tuzuru/blob/main/.github/actions/tuzuru-deploy/action.yml)
+   * Install tuzuru via npm, generate blog, upload the artefact, and deploy to GitHub page
+* [ainame/Tuzuru/.github/actions/tuzuru-generate](https://github.com/ainame/tuzuru/blob/main/.github/actions/tuzuru-generate/action.yml)
+   * Only install tuzuru via npm and generate blog
+   * You can deploy to anywhere you like
+
+Their versions should match the CLI’s version. When you update the CLI version, you should also update the action’s version.
+It is recommended to use Renovate or Dependabot to keep it up to date.
+
+**Note that sicne Tuzuru relies on Git history, you have to checkout git repo with the entire history. Specify `fetch-deploy: 0` in `actions/checkout`**
+
+This is an exmaple `.github/workflows/deploy.yml`.
+
+<details>
+
+```yaml
+name: Deploy
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+      - uses: ainame/Tuzuru/.github/actions/tuzuru-deploy@0.1.2
+```
+
+</details>
+
 ### Built-in layout
 
 The built-in layout is a great starting point and is easy to customize. It already includes [github-markdown-css](https://github.com/sindresorhus/github-markdown-css) and [highlight.js](https://highlightjs.org/) to make writing tech blog posts a breeze.
 
-
 ![screenshot](.github/assets/screenshot.png)
 
-### Example project structure
+### Demo
+
+You can see Tuzuru in action with this demo blog hosted on GitHub Pages:
+
+- **Live Demo**: [https://ainame.tokyo/tuzuru-demo/](https://ainame.github.io/tuzuru-demo/)
+- **Source Repository**: [https://github.com/ainame/tuzuru-demo](https://github.com/ainame/tuzuru-demo)
+
+This demo showcases the built-in layout.
+
+## How it works
+
+This is how a tuzuru project look like.
 
 ```
 my-blog/
@@ -115,16 +180,10 @@ my-blog/
 └── tuzuru.json
 ```
 
-### Demo
-
-You can see Tuzuru in action with this demo blog hosted on GitHub Pages:
-
-- **Live Demo**: [https://ainame.tokyo/tuzuru-demo/](https://ainame.github.io/tuzuru-demo/)
-- **Source Repository**: [https://github.com/ainame/tuzuru-demo](https://github.com/ainame/tuzuru-demo)
-
-This demo showcases the built-in layout and demonstrates how Tuzuru generates clean, lightweight blog pages from plain Markdown files.
-
-## How it works
+* `contents/` - where you put markdown files
+* `templates/` - layout files
+* `assets/` - place to locate your assets files, like css or images
+* `tuzuru.json` - configuration
 
 ### Layout and customization
 
@@ -165,7 +224,9 @@ To prevent browser cache issues, use the `{{buildVersion}}` variable in your tem
 
 ### tuzuru.json
 
-`tuzuru.json` is the main configuration file, though you can omit most settings if you stick to the defaults.
+`tuzuru.json` is the main configuration file.
+By default, you get only `metadata` section by `tuzuru init` but
+here's the rest of customization you can do.
 
 
 ```javascript
@@ -255,7 +316,7 @@ tuzuru serve --config my-config.json
 The serve command automatically watches for changes in your source files and regenerates the blog when needed:
 
 - **Content files**: Watches `contents/` and `contents/unlisted/` directories
-- **Asset files**: Watches the `assets/` directory  
+- **Asset files**: Watches the `assets/` directory
 - **Templates**: Watches template files for changes
 
 When files are modified, the blog is regenerated on the next HTTP request, providing a seamless development experience without manual rebuilds.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ainame/tuzuru",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "description": "Tuzuru static blog generator (npm wrapper around prebuilt binaries)",
   "license": "MIT",
   "private": false,