chore: Update README (#55)

Co-authored-by: junrangao <[email protected]>

Author: gaojunran

README.md

@@ -1,5 +1,177 @@
-## Pitchfork
+<div align="center">
 
-A tool for wrangling daemons. [See docs](https://pitchfork.jdx.dev).
+<h1 align="center">
+  <a href="https://pitchfork.jdx.dev">
+    <img src="logo.png" alt="pitchfork" width="256" height="256" />
+    <br>
+    pitchfork
+  </a>
+</h1>
 
-![pitchfork logo](https://pitchfork.jdx.dev/assets/logo.CjqAML_x.png)
+<p>
+  <a href="https://crates.io/crates/pitchfork-cli"><img alt="Crates.io" src="https://img.shields.io/crates/v/pitchfork-cli?style=for-the-badge&color=00d9ff"></a>
+  <a href="https://github.com/jdx/pitchfork/blob/main/LICENSE"><img alt="GitHub" src="https://img.shields.io/github/license/jdx/pitchfork?style=for-the-badge&color=52e892"></a>
+  <a href="https://github.com/jdx/pitchfork/actions/workflows/ci.yml"><img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/jdx/pitchfork/ci.yml?style=for-the-badge&color=ff9100"></a>
+</p>
+
+<p><b>Daemons with DX</b></p>
+
+<p align="center">
+  <a href="https://pitchfork.jdx.dev/getting-started.html">Getting Started</a> •
+  <a href="https://pitchfork.jdx.dev">Documentation</a> •
+  <a href="https://pitchfork.jdx.dev/cli">CLI Reference</a>
+</p>
+
+<hr />
+
+</div>
+
+## What is it?
+
+Pitchfork is a CLI for managing daemons with a focus on developer experience.
+
+- **Start services once** - Only start daemons if they have not already been started
+- **Auto start/stop** - Automatically start daemons when entering a project directory, stop when leaving
+- **Ready checks** - Based on delay, output or HTTP response
+- **Restart on failure** - Automatically restart daemons when they crash
+- **Cron jobs** - Schedule recurring tasks
+- **Start on boot** - Automatically start daemons when your system boots
+- **Project configuration** - Define all your project's daemons in `pitchfork.toml`
+
+> [!WARNING]
+> This project is experimental. It works in basic situations but you'll undoubtedly encounter bugs.
+
+## Use Cases
+
+- Launching development services like web APIs and databases
+- Running rsync/unison to synchronize directories with a remote machine
+- Managing background processes for your project
+
+## Quickstart
+
+### Install pitchfork
+
+[mise-en-place](https://mise.jdx.dev) is the recommended way to install pitchfork:
+
+```sh-session
+$ mise use -g pitchfork
+```
+
+Or install via cargo:
+
+```sh-session
+$ cargo install pitchfork-cli
+```
+
+Or download from [GitHub releases](https://github.com/jdx/pitchfork/releases).
+
+### Launch a one-off daemon
+
+Run a process in the background—an alternative to shell jobs (`mytask &`):
+
+```sh-session
+$ pitchfork run docs -- npm start docs-dev-server
+```
+
+### Add daemons to your project
+
+Create a `pitchfork.toml` in your project root:
+
+```toml
+[daemons.redis]
+run = "redis-server"
+
+[daemons.api]
+run = "npm run server:api"
+
+[daemons.docs]
+run = "npm run server:docs"
+```
+
+Start all daemons:
+
+```sh-session
+$ pitchfork start --all
+```
+
+Or start individual ones:
+
+```sh-session
+$ pitchfork start redis
+```
+
+### Shell hook (auto start/stop)
+
+Enable automatic daemon management when entering/leaving project directories:
+
+```sh-session
+echo '$(pitchfork activate bash)' >> ~/.bashrc
+echo '$(pitchfork activate zsh)' >> ~/.zshrc
+echo 'pitchfork activate fish | source' >> ~/.config/fish/config.fish
+```
+
+Configure daemons with auto start/stop:
+
+```toml
+[daemons.api]
+run = "npm run server:api"
+auto = ["start", "stop"]
+```
+
+### View logs
+
+View daemon logs:
+
+```sh-session
+$ pitchfork logs api
+[2021-08-01T12:00:00Z] api: starting
+[2021-08-01T12:00:01Z] api: listening on
+```
+
+Logs will be saved to `~/.local/state/pitchfork/logs`.
+
+## Example Project
+
+Here's a complete example showing how to use pitchfork for a development environment:
+
+```toml
+# pitchfork.toml
+[daemons.postgres]
+run = "docker run --rm -p 5432:5432 -e POSTGRES_PASSWORD=dev postgres:16"
+auto = ["start", "stop"]
+ready.http = { url = "http://localhost:5432" }
+
+[daemons.redis]
+run = "redis-server --port 6379"
+auto = ["start", "stop"]
+ready.delay = "2s"
+
+[daemons.api]
+run = "npm run dev:api"
+auto = ["start", "stop"]
+ready.http = { url = "http://localhost:3000/health" }
+depends = ["postgres", "redis"]
+
+[daemons.worker]
+run = "npm run dev:worker"
+auto = ["start"]
+depends = ["postgres", "redis"]
+
+[daemons.sync]
+run = "rsync -avz --delete remote:/data/ ./local-data/"
+cron = "0 */5 * * * *"  # Run every 5 minutes
+```
+
+Start everything:
+
+```sh-session
+$ pitchfork start --all
+```
+
+## Full Documentation
+
+See [pitchfork.jdx.dev](https://pitchfork.jdx.dev)
+
+## Contributors
+
+[![Contributors](https://contrib.rocks/image?repo=jdx/pitchfork)](https://github.com/jdx/pitchfork/graphs/contributors)