Update README.md

README.md

@@ -1,11 +1,55 @@
-# commitm
+# commitm with Homebrew
 
-## How do I install this formula?
+Use the `commitm` command to generate commit messages, modify them, and commit!
 
-`brew install marissamarym/commitm/commitm`
+<img width="1114" alt="Screenshot 2024-02-20 at 4 29 37 PM" src="https://github.com/marissamarym/commitm/assets/1459660/a839c133-4160-4999-91c0-4babf8d0ae11">
 
-Or `brew tap marissamarym/commitm` and then `brew install commitm`.
+Inspired by [my brother Adam's AI Shell Command Generator](https://gist.github.com/montasaurus/5ccbe453ef863f702291e763b1b63daf) ([tweet](https://twitter.com/montasaurus_rex/status/1758506549478097383)).
 
-## Documentation
+The `commitm` command:
 
-`brew help`, `man brew` or check [Homebrew's documentation](https://docs.brew.sh).
+- Runs `git commit --dry-run -v` to get a summary of your staged changes.
+- Prompts `llm` to generate a commit message.
+- Asks if you want to commit the message, modify it (make it shorter, longer, more detailed, or more general), or enter a custom message.
+
+## Getting Started
+
+### Installation
+
+```bash
+brew install marissamarym/commitm/commitm
+```
+
+Or
+
+```bash
+brew tap marissamarym/commitm
+```
+
+and then
+
+```bash
+brew install commitm
+```
+
+## Usage
+
+To generate a commit message:
+
+```bash
+commitm
+```
+
+To generate a commit message and commit it immediately:
+
+```bash
+commitm -e
+```
+
+## Contributing
+
+Any contributions you make are greatly appreciated.
+
+## License
+
+Distributed under the MIT License. See LICENSE for more information.