# Rune Scribe for Obsidian

Rune Scribe counts English and CJK writing units for the current note, a folder, or the whole vault. It also surfaces word-frequency tables so you can study repeated terms and writing habits.

## Features

- Count the active Markdown file.
- Count a folder from the file menu.
- Open a sidebar dashboard for active file, active folder, or vault statistics.
- Separate English and CJK counts while also reporting a combined total.
- Frequency tables for English words and CJK terms.
- CSV export for frequency tables.
- Configurable rules for frontmatter, code, tags, numbers, wikilinks, CJK locale, and reading speed.
- Per-file cache for faster repeated folder and vault counts.
- Markdown-aware text cleanup for frontmatter, code, links, embeds, tags, and common formatting.

## Development

```bash
npm install
npm test
npm run build
```

Copy `main.js`, `manifest.json`, and `styles.css` into an Obsidian vault plugin folder such as:

```text
YourVault/.obsidian/plugins/runescribe/
```

## Release checklist

- Confirm `author` and `authorUrl` in `manifest.json`.
- Update `manifest.json`, `versions.json`, and `package.json` to the same release version.
- Run `npm test` and `npm run build`.
- Create a GitHub release with a tag that matches the manifest version.
- Attach `main.js`, `manifest.json`, and `styles.css` to the release.