# Goal Ledger

[English](README.md) | [简体中文](README.zh-CN.md)

Goal Ledger is an offline-first Obsidian plugin for saving toward personal goals through income records. Set a target amount and deadline, record each income entry, and keep the finished goal as a milestone you can revisit.

## Features

- Create multiple goals with a target amount, deadline, and currency.
- Record income with a source, amount, date, and optional details.
- Follow progress, remaining amount, deadline status, and the first achievement snapshot.
- Review income in a 12-week heatmap. Days without income remain transparent.
- Archive completed or inactive goals without deleting their records.
- Follow Obsidian's language setting with English and Simplified Chinese interfaces.

## Currencies

Each goal uses one currency: CNY, USD, EUR, GBP, JPY, HKD, TWD, or KRW. New goals default to USD in English and CNY in Simplified Chinese. Goal totals are never converted or combined across currencies. The currency becomes fixed after recording income or saving an achievement milestone.

## Privacy

Goal Ledger stores its data only in the current vault's plugin data. It does not require an account and does not send data over the network.

## Install

After Goal Ledger is listed in the Obsidian Community plugins directory, install it from **Settings → Community plugins**. For a manual installation, download `main.js`, `manifest.json`, and `styles.css` from a GitHub release into `<vault>/.obsidian/plugins/goal-ledger`, then enable the plugin in Obsidian.

## Development

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

The plugin requires Obsidian 1.5.0 or newer.

## License

Distributed under the [MIT License](LICENSE).