# Writing Habit for Obsidian

Track your typed words, pasted words, sprints, streaks, and leaderboards, synced with your [Writing Habit](https://writinghabit.app) account.

## What it does

Writing Habit measures your actual writing output as you type in Obsidian, separating words you typed from words you pasted. It syncs your stats with the Writing Habit platform, where you can:

- **Track daily and lifetime word counts** across all your writing apps
- **Run writing sprints** with timers and stretch goals
- **Build streaks** by hitting your daily target
- **Compete on leaderboards** with other writers
- **View your stats** in a sidebar panel inside Obsidian

## Requirements

A free [Writing Habit account](https://writinghabit.app) is required. You can sign up on the website or through the plugin's sign-in panel.

## Installation

### From the Community Plugin Directory (recommended)

1. Open Obsidian Settings → Community plugins → Browse.
2. Search for **Writing Habit**.
3. Click **Install**, then **Enable**.

### Manual installation

1. Download `main.js`, `manifest.json`, and `styles.css` from the [latest release](https://github.com/writinghabit/obsidian-plugin/releases/latest).
2. Copy them into `.obsidian/plugins/writing-habit/` inside your vault.
3. Open Obsidian Settings → Community plugins and enable **Writing Habit**.

## Getting started

1. Click the **pen** icon in the ribbon (left sidebar) to open the Writing Habit panel.
2. Click **Sign in with Google** (or use email/password). Your browser will open the Writing Habit sign-in page.
3. After signing in, the panel will show your session stats and today's progress.
4. Start writing — your word count updates automatically as you type.

## Settings

Open Obsidian Settings → Writing Habit to:

- Choose which project your Obsidian notes count toward.
- Set a daily word-count target.
- Enable or disable specific features.

## Privacy

Writing Habit only tracks word counts — it never reads, stores, or transmits the content of your notes. See the [Privacy Policy](https://writinghabit.app/privacy) for details.

## Support

- Website: [writinghabit.app](https://writinghabit.app)
- Issues: [GitHub Issues](https://github.com/writinghabit/obsidian-plugin/issues)