summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 11 insertions, 8 deletions
diff --git a/README.md b/README.md
index 5cdd928..b998abd 100644
--- a/README.md
+++ b/README.md
@@ -27,14 +27,17 @@ icloud-note update --title "Hello" --body "Revised from Linux"
## Formatting
-Bodies may be plain text or light Markdown. The CLI rewrites them to **Apple Notes
-style** before writing:
-
-- First line = Title; blank line before the rest
-- `##` / `###` → Heading / Subheading (no `#` markers)
-- `-` / `*` bullets → `•`; `1.` lists kept; `- [ ]` / `- [x]` → ☐ / ☑
-- Inline `**bold**`, links, and outer code fences cleaned up
-- Short paragraphs and list blocks spaced like Notes (not a Markdown dump)
+Bodies may be plain text or light Markdown. The CLI rewrites them to match
+[Apple Notes formatting](https://support.apple.com/guide/iphone/create-and-format-notes-iph1ac0b3a2/ios)
+([Mac guide](https://support.apple.com/guide/notes/format-notes-apd1955d3b21/mac),
+[lists](https://support.apple.com/guide/notes/add-lists-apd93c815aa0/mac)):
+
+- First line = **Title**; blank line before the rest
+- `##` / `###` → **Heading** / **Subheading** (collapsible sections on device)
+- List shortcuts: `*` → bulleted (`•`), `-` → dashed (`–`), `1.` → numbered
+- `- [ ]` / `- [x]` → checklist (☐ / ☑)
+- `---` → divider line; `> …` → block quote; pipe tables → aligned monospaced grid
+- Inline `**bold**` / links / fences cleaned (rich bold/highlight needs the iOS UI)
`ICLOUD_NOTES_DRY_RUN=1` prints a formatted preview without touching iCloud.