diff --git a/README.md b/README.md index 335e62f..cb744c8 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,23 @@ -# build-pulse +# Build Pulse 🦀 -a research-focused Jenkins CI/CD static build analyzer +A tiny, fast command-line utility that watches for file changes in a directory and automatically runs a specified command. It's a perfect companion for your development workflow, automating tasks like compiling code, running tests, or refreshing a server. + + + +--- + +## Why Use Build Pulse? + +* **⚡ Blazingly Fast**: Built in Rust for minimal resource usage and instant response times. +* **👌 Dead Simple**: No complex configuration files. Just a single command to get started. +* **✅ Cross-Platform**: Works on macOS, Windows, and Linux. +* **🛠️ Flexible**: Ideal for any project—Rust, Node.js, Python, web development, and more. + +--- + +## Installation + +You can install Build Pulse directly from the source using `cargo`. Make sure you have the Rust toolchain installed. + +```bash +cargo install --git [https://github.com/Akhilanandateja/build-pulse](https://github.com/Akhilanandateja/build-pulse) \ No newline at end of file