updated readme

[benkleyner]

updated readme

Watch newly created sync directories

Summary by CodeRabbit

• Documentation

  • Added comprehensive documentation for the dev-sync CLI tool, including build requirements, quick start guide, commands reference, configuration details, and known limitations.

• New Features

  • Added real-time detection and synchronization of newly created subdirectories during sync operations.

[coderabbitai]

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Free

Run ID: d8c8ef45-342c-47b9-9a21-82ae7fe3d5d6

📥 Commits

Reviewing files that changed from the base of the PR and between 8319bc5 and 8cf35ca.

📒 Files selected for processing (5)

• README.md
• daemon.go
• main.go
• watcher.go
• watcher_test.go

---

📝 Walkthrough

Walkthrough

Adds WatchCreatedDir(path string) error to Watcher, which stats a path and calls addTree if it is a directory. Both daemon.go watchLoop and main.go runSyncLoop now call this method on each received filesystem event so newly created subdirectories are watched. A test validates the end-to-end behavior. The README is replaced with full tool documentation.

Changes

New subdirectory watching + documentation

Layer / File(s)	Summary
WatchCreatedDir method and test watcher.go, watcher_test.go	Adds os import and the WatchCreatedDir exported method, which stats the path, skips missing or non-directory paths, and calls addTree for the subtree. The test verifies that a file written into a newly registered subdirectory produces a watcher event.
Event loop integration daemon.go, main.go	watchLoop in daemon.go and runSyncLoop in main.go now call WatchCreatedDir(ev.Name) on each received event, logging or printing errors without stopping the loop.
README documentation rewrite README.md	Replaces the stub README with full documentation: feature overview, build requirements, quick-start, command reference table, config/daemon artifact locations, and known limitations.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐇 Hop hop, a new dir appears,
The watcher perks up both long ears.
WatchCreatedDir says "I see you!"
Events flow in, fresh files anew.
No more missed paths — the rabbit cheers! 🌿

---

Note

🎁 Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login.

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[benkleyner]

• Verify SFTP host keys #16
• updated readme #15 👈 (View in Graphite)
• master

This stack of pull requests is managed by Graphite. Learn more about stacking.

[benkleyner]

Merge activity

• Jun 15, 12:21 AM UTC: A user started a stack merge that includes this pull request via Graphite.
• Jun 15, 12:21 AM UTC: @benkleyner merged this pull request with Graphite.