Skip to content

Commit 96445ad

Browse files
committed
chore(package): update version to 0.0.12 and enhance description.
1 parent 96c293c commit 96445ad

File tree

3 files changed

+73
-3
lines changed

3 files changed

+73
-3
lines changed

LICENSE

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
MIT License
2+
3+
Copyright (c) Gabriel Ribeiro, https://github.com/ribeirogab
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a
6+
copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
7+
8+
The above copyright notice and this permission notice shall be included
9+
in all copies or substantial portions of the Software.
10+
11+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
12+
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
13+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
14+
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
15+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

Lines changed: 56 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,57 @@
1-
# Commitfy
1+
# commitfy
22

3+
> Make commits easier and faster using AI.
4+
5+
## Installation
6+
7+
Install `commitfy` globally (to use in any repository) using npm:
8+
9+
```bash
10+
npm install -g commitfy
11+
```
12+
13+
## Usage
14+
15+
Once installed, you can use the `commitfy` command or its alias `cfy` to interact with the tool.
16+
17+
### Commands
18+
19+
#### Setup
20+
21+
To perform initial setup configuration, run:
22+
23+
```bash
24+
cfy setup
25+
```
26+
27+
#### Generate Commit
28+
29+
To generate a commit message using AI, simply run:
30+
31+
```bash
32+
cfy
33+
```
34+
35+
> **Note:** Before generating a commit message, ensure you are in a repository with Git initialized and have files added to the stage using `git add`.
36+
37+
#### Help
38+
39+
If you need assistance or want to see the available commands, run:
40+
41+
```bash
42+
commitfy --help
43+
```
44+
45+
## AI Providers
46+
47+
`commitfy` supports the following AI providers for generating commit messages:
48+
49+
- **OpenAI**
50+
51+
> **Note:** Currently, we support the above providers, but we may implement more in the future. If you have a suggestion for an AI provider, please [open an issue](https://github.com/ribeirogab/commitfy/issues).
52+
53+
## Support
54+
55+
Contact me!
56+
57+
- E-mail <a href="mailto:[email protected]" target="_blank">`[email protected]`</a>

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
{
22
"name": "commitfy",
3-
"version": "0.0.11",
3+
"version": "0.0.12",
44
"main": "lib/index.js",
55
"repository": "https://github.com/ribeirogab/commitfy.git",
66
"author": "ribeirogab <[email protected]>",
77
"license": "MIT",
8-
"description": "✨ Make commits easier and faster using AI.",
8+
"description": "Generate your commit in 1 second with AI.",
99
"keywords": [
1010
"ai",
1111
"commit",

0 commit comments

Comments
 (0)