summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md52
1 files changed, 52 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b90b8f0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,52 @@
+# iphone-notes
+
+Create real **Apple Notes** on an iPhone from Linux by driving
+[icloud.com/notes](https://www.icloud.com/notes/) with Playwright and a saved
+Apple ID browser session.
+
+Also packaged as a Cursor/Goose agent skill (`SKILL.md`) so agents can forward
+prompt results to your phone as Notes.
+
+## Quick start
+
+```bash
+./scripts/setup.sh
+icloud-note login # Apple ID + 2FA once (graphical session)
+icloud-note create --title "Hello" --body "From Linux"
+```
+
+## CLI
+
+| Command | Purpose |
+|---|---|
+| `icloud-note setup` | Install Playwright Chromium + `~/.local/bin` wrapper |
+| `icloud-note login` | Headed sign-in; saves session under `~/.config/icloud-notes/` |
+| `icloud-note status` | Check whether the saved session can open Notes |
+| `icloud-note create` | Create a note (`--title`, `--body` / `--body-file`) |
+
+## Layout
+
+```text
+SKILL.md Agent instructions
+scripts/icloud-note.mjs CLI
+scripts/setup.sh One-time install + skill symlinks
+tests/cli.test.sh Smoke tests (no Apple network required)
+```
+
+Runtime config (not in git):
+
+```text
+~/.config/icloud-notes/
+ browser-profile/ Playwright persistent profile (private)
+ node_modules/ Playwright install
+```
+
+## Tests
+
+```bash
+./tests/cli.test.sh
+```
+
+## License
+
+MIT