Skip to content

Commit 283024e

Browse files
committed
docs(cli): update command references to use scoped package name
- Change git-smart to npx @neabyte/git-smart in all examples - Add global installation alternative commands - Update README.md and API.md with correct package usage - Align documentation with published npm package
1 parent 8255f3a commit 283024e

File tree

2 files changed

+37
-14
lines changed

2 files changed

+37
-14
lines changed

API.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
Main class for generating commit messages.
88

99
```javascript
10-
const { GitSmart } = require('git-smart')
10+
const { GitSmart } = require('@neabyte/git-smart')
1111

1212
const gitSmart = new GitSmart({
1313
interactive: false,
@@ -29,7 +29,7 @@ await gitSmart.run()
2929
Generates commit messages based on analysis.
3030

3131
```javascript
32-
const { MessageGenerator } = require('git-smart/src/generators/MessageGenerator')
32+
const { MessageGenerator } = require('@neabyte/git-smart/src/generators/MessageGenerator')
3333

3434
const generator = new MessageGenerator()
3535
const messages = generator.generateMessages(analysis, styleGuide, options)
@@ -49,7 +49,7 @@ Categories include: api, ui, auth, database, config, security, build, ci, deploy
4949
Analyzes git diff and staged files.
5050

5151
```javascript
52-
const { DiffAnalyzer } = require('git-smart/src/analyzers/DiffAnalyzer')
52+
const { DiffAnalyzer } = require('@neabyte/git-smart/src/analyzers/DiffAnalyzer')
5353

5454
const analyzer = new DiffAnalyzer()
5555
const analysis = analyzer.analyze(diff, stagedFiles)
@@ -60,14 +60,32 @@ const analysis = analyzer.analyze(diff, stagedFiles)
6060
Analyzes commit history for style patterns.
6161

6262
```javascript
63-
const { HistoryAnalyzer } = require('git-smart/src/analyzers/HistoryAnalyzer')
63+
const { HistoryAnalyzer } = require('@neabyte/git-smart/src/analyzers/HistoryAnalyzer')
6464

6565
const historyAnalyzer = new HistoryAnalyzer()
6666
const styleGuide = historyAnalyzer.generateStyleGuide(commits)
6767
```
6868

6969
## CLI Usage
7070

71+
```bash
72+
# Basic usage
73+
npx @neabyte/git-smart
74+
75+
# Interactive mode
76+
npx @neabyte/git-smart --interactive
77+
78+
# Dry run
79+
npx @neabyte/git-smart --dry-run
80+
81+
# Verbose output
82+
npx @neabyte/git-smart --verbose
83+
84+
# Help
85+
npx @neabyte/git-smart --help
86+
```
87+
88+
Or if installed globally:
7189
```bash
7290
# Basic usage
7391
git-smart

README.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,20 @@ AI-powered git commit message generator that works completely offline. Analyzes
1414
## Installation
1515

1616
```bash
17-
npm install -g git-smart
17+
npm install -g @neabyte/git-smart
1818
```
1919

2020
Or use directly:
2121
```bash
22-
npx git-smart
22+
npx @neabyte/git-smart
2323
```
2424

2525
## Usage
2626

2727
### Basic Usage
2828
```bash
2929
git add .
30-
git-smart
30+
npx @neabyte/git-smart
3131
```
3232

3333
Example output:
@@ -40,7 +40,7 @@ Use this message? (Y/n): y
4040

4141
### Interactive Mode
4242
```bash
43-
git-smart --interactive
43+
npx @neabyte/git-smart --interactive
4444
```
4545

4646
Example output:
@@ -64,7 +64,7 @@ Choose (1-4): 1
6464
### Options
6565

6666
```bash
67-
git-smart [options]
67+
npx @neabyte/git-smart [options]
6868

6969
Options:
7070
-i, --interactive Interactive mode with multiple suggestions
@@ -73,6 +73,11 @@ Options:
7373
-h, --help Show help message
7474
```
7575

76+
Or if installed globally:
77+
```bash
78+
git-smart [options]
79+
```
80+
7681
## Commit Format
7782

7883
Git-Smart generates commits in the format: **`type(action): description`**
@@ -196,7 +201,7 @@ init(project): setup initial project structure
196201
### Adding Authentication
197202
```bash
198203
$ git add src/auth.js src/login.js
199-
$ git-smart
204+
$ npx @neabyte/git-smart
200205

201206
🔍 Analyzing changes...
202207
💡 Suggested commit: "feat(auth): implement user authentication system"
@@ -205,7 +210,7 @@ $ git-smart
205210
### Bug Fix
206211
```bash
207212
$ git add src/api/users.js
208-
$ git-smart
213+
$ npx @neabyte/git-smart
209214

210215
🔍 Analyzing changes...
211216
💡 Suggested commit: "fix(api): resolve null response handling"
@@ -214,7 +219,7 @@ $ git-smart
214219
### Documentation Update
215220
```bash
216221
$ git add README.md docs/
217-
$ git-smart
222+
$ npx @neabyte/git-smart
218223

219224
🔍 Analyzing changes...
220225
💡 Suggested commit: "docs(readme): update API documentation"
@@ -223,7 +228,7 @@ $ git-smart
223228
### Test Addition
224229
```bash
225230
$ git add tests/auth.test.js
226-
$ git-smart
231+
$ npx @neabyte/git-smart
227232

228233
🔍 Analyzing changes...
229234
💡 Suggested commit: "test(auth): add authentication test coverage"
@@ -233,7 +238,7 @@ $ git-smart
233238

234239
1. Fork the repository at [https://github.com/NeaDigitra/Git-Smart](https://github.com/NeaDigitra/Git-Smart)
235240
2. Create your feature branch: `git checkout -b feat/new-feature`
236-
3. Commit your changes: `git-smart`
241+
3. Commit your changes: `npx @neabyte/git-smart`
237242
4. Push to the branch: `git push origin feat/new-feature`
238243
5. Submit a pull request
239244

0 commit comments

Comments
 (0)