summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
index 1261355..5cdd928 100644
--- a/README.md
+++ b/README.md
@@ -25,6 +25,19 @@ icloud-note update --title "Hello" --body "Revised from Linux"
| `icloud-note create` | Headless **new** note (`--title`, `--body` / `--body-file`) |
| `icloud-note update` | Headless **update** existing note by title (never creates) |
+## 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)
+
+`ICLOUD_NOTES_DRY_RUN=1` prints a formatted preview without touching iCloud.
+
## Layout
```text