@rafaeelricco/commit-tools 0.1.6 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # commit-tools
2
2
 
3
- [![Version](https://img.shields.io/badge/version-0.1.2-blue.svg)](#)
3
+ [![Version](https://img.shields.io/badge/version-0.2.0-blue.svg)](#)
4
4
 
5
5
  Writing good commit messages _can_ have a high cognitive cost, especially when you make dozens of commits a day. That energy should be directed toward solving hard problems and shipping features, not summarizing them.
6
6
 
@@ -17,15 +17,9 @@ While built-in IDE tools (like Cursor, VSCode, or Windsurf) offer basic AI commi
17
17
 
18
18
  ## Quick Install
19
19
 
20
- **Prerequisites:** commit-tools requires the [Bun](https://bun.sh) runtime.
20
+ **Prerequisites:** [Node.js](https://nodejs.org) ≥ 20
21
21
 
22
22
  ```bash
23
- curl -fsSL https://bun.sh/install | bash
24
- ```
25
-
26
- ```bash
27
- bun install -g @rafaeelricco/commit-tools
28
- # or
29
23
  npm install -g @rafaeelricco/commit-tools
30
24
  ```
31
25
 
@@ -96,7 +90,7 @@ commit setup
96
90
 
97
91
  You will be prompted to choose:
98
92
 
99
- - **Auth method**: OAuth (sign in with your account) or BYOK (paste your own API key)
93
+ - **Auth method**: OAuth (sign in with your Google or ChatGPT account) or API Key (paste your own key)
100
94
  - **Commit convention**: Conventional, Imperative, or Custom
101
95
 
102
96
  To re-authenticate at any time:
@@ -157,9 +151,11 @@ commit --help
157
151
 
158
152
  ## Providers
159
153
 
160
- Currently powered by **Google Gemini**. More providers are coming soon:
154
+ - **Google Gemini** API key or Google OAuth
155
+ - **OpenAI** — API key or sign in with your ChatGPT Plus/Pro subscription
156
+
157
+ More providers coming soon:
161
158
 
162
- - **OpenAI** (GPT-4o, o1, o3, etc.)
163
159
  - **Anthropic** (Claude)
164
160
 
165
161
  Contributions and feedback are welcome!