From 9753f28c1f13443e536acdb3ae3522a3705803ed Mon Sep 17 00:00:00 2001
From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com>
Date: Wed, 25 Mar 2026 07:51:22 +0000
Subject: [PATCH] Add README.md with project description and usage guide

Co-authored-by: lucabol <1370774+lucabol@users.noreply.github.com>
Agent-Logs-Url: https://github.com/lucabol/notes/sessions/04c59d90-3624-4e04-a352-16b52654c04f
---
 README.md | 117 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 117 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..aa20c7d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,117 @@
+# notes
+
+A lightweight CLI tool for managing plain-text markdown notes, written in PowerShell. Notes are stored as `.md` files in a local folder, making them easy to sync, back up, or use with any text editor.
+
+## Features
+
+- **CRUD operations** – create, list, show, edit, and remove notes
+- **Full-text search** – find notes by content (case-insensitive)
+- **Tag support** – tag notes by putting a `#tag` on the first line and filter by tag across all commands
+- **Standard Notes import** – migrate from a Standard Notes backup in one command
+- **Pager support** – long output is automatically piped through your preferred pager
+- **Cross-platform** – runs on Windows, macOS, and Linux via PowerShell 7+
+
+## Requirements
+
+- [PowerShell 7+](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell) (`pwsh`)
+
+## Installation
+
+Clone or download the repository, then optionally add `notes.ps1` to a directory on your `PATH` (or create an alias/function in your PowerShell profile).
+
+```powershell
+git clone https://github.com/lucabol/notes.git
+cd notes
+```
+
+## Quick start
+
+```powershell
+# Create a note (opens in $EDITOR)
+.\notes.ps1 add "My First Note"
+
+# List all notes
+.\notes.ps1 list
+
+# Show a note
+.\notes.ps1 show "My First Note"
+
+# Edit a note
+.\notes.ps1 edit "My First Note"
+
+# Delete a note
+.\notes.ps1 remove "My First Note"
+
+# Search across all notes
+.\notes.ps1 search "keyword"
+```
+
+## Commands
+
+| Command | Description |
+|---|---|
+| `add <title>` | Create a new note and open it in the editor |
+| `list [pattern]` | List all notes, optionally filtered by name or tag |
+| `show <title>` | Print a note's content to the terminal |
+| `edit <title>` | Open a note in the editor |
+| `remove <title> [-Force]` | Delete a note (prompts for confirmation unless `-Force`) |
+| `search <text> [tag]` | Search note contents for text, optionally scoped to a tag |
+| `check` | Show the notes directory path and verify it is accessible |
+| `import <path>` | Import notes from a Standard Notes backup directory |
+| `help` | Show the built-in help message |
+
+## Tags
+
+Tag a note by placing a `#tag` token on the **first line**:
+
+```markdown
+# My Cooking Notes #Recipes
+
+...
+```
+
+Then filter any command by tag using one of three equivalent prefixes:
+
+```powershell
+.\notes.ps1 list +Recipes          # recommended — works unquoted in all shells
+.\notes.ps1 list tag:Recipes       # also works unquoted everywhere
+.\notes.ps1 list '#Recipes'        # needs quotes (# is a comment character)
+
+.\notes.ps1 search "chicken" +Recipes   # search within a single tag
+```
+
+## Configuration
+
+| Environment variable | Default | Description |
+|---|---|---|
+| `NOTES_DIR` | `~/notes` | Directory where notes are stored |
+| `EDITOR` / `VISUAL` | `notepad` (Windows) | Editor used for `add` and `edit` |
+| `PAGER` | `more.com` (Windows) | Pager used for long output |
+
+```powershell
+# Example: use VS Code and store notes on a synced drive
+$env:EDITOR   = "code --wait"
+$env:NOTES_DIR = "$HOME/Dropbox/notes"
+```
+
+## Importing from Standard Notes
+
+Export your Standard Notes data as a `.zip` backup, unzip it, then run:
+
+```powershell
+.\notes.ps1 import "C:\path\to\standard-notes-backup"
+```
+
+Each note is converted from the Standard Notes Lexical format and saved as a `.md` file.
+
+## Running tests
+
+The project uses [Pester](https://pester.dev/) for tests and [PSScriptAnalyzer](https://github.com/PowerShell/PSScriptAnalyzer) for linting. The CI script installs both automatically:
+
+```powershell
+.\ci.ps1
+```
+
+## License
+
+MIT