Skip to content

Commit f53fc32

Browse files
Merge pull request #5 from MUGISHA-Pascal/pascal-dev
feat : rename package
2 parents 503a984 + ee0fc78 commit f53fc32

7 files changed

Lines changed: 33 additions & 29 deletions

File tree

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,4 @@ dist/
77
coverage/
88
.vscode/
99
.idea/
10+
.npmrc

EXAMPLES.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
1-
# start-it Examples
1+
# start-it-cli Examples
22

33
## Installation
44

55
### Global Installation
66

77
```bash
8-
npm install -g start-it
8+
npm install -g start-it-cli
99
```
1010

1111
### Local Installation
1212

1313
```bash
14-
npm install start-it
15-
npx start-it
14+
npm install start-it-cli
15+
npx start-it-cli
1616
```
1717

1818
## Usage Examples
1919

2020
### Creating a Go Project
2121

2222
```bash
23-
$ start-it
23+
$ start-it-cli
2424
? What type of project would you like to create? Go
2525
? Project name: my-go-app
2626
? Select Go template: Web API

INSTALLATION.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,30 +9,30 @@
99

1010
### 1. Global Installation (Recommended)
1111

12-
Install start-it globally to use it from anywhere:
12+
Install start-it-cli globally to use it from anywhere:
1313

1414
```bash
15-
npm install -g start-it
15+
npm install -g start-it-cli
1616
```
1717

1818
Then use it from any directory:
1919

2020
```bash
21-
start-it
21+
start-it-cli
2222
```
2323

2424
### 2. Local Installation
2525

2626
Install in your project directory:
2727

2828
```bash
29-
npm install start-it
29+
npm install start-it-cli
3030
```
3131

3232
Then use it with npx:
3333

3434
```bash
35-
npx start-it
35+
npx start-it-cli
3636
```
3737

3838
### 3. Development Installation
@@ -50,21 +50,21 @@ npm link
5050
Then use it as:
5151

5252
```bash
53-
start-it
53+
start-it-cli
5454
```
5555

5656
## Verification
5757

5858
To verify the installation was successful:
5959

6060
```bash
61-
start-it --version
61+
start-it-cli --version
6262
```
6363

6464
Or simply run:
6565

6666
```bash
67-
start-it
67+
start-it-cli
6868
```
6969

7070
You should see the welcome message and be prompted to select a framework.
@@ -74,26 +74,26 @@ You should see the welcome message and be prompted to select a framework.
7474
### Global Installation
7575

7676
```bash
77-
npm uninstall -g start-it
77+
npm uninstall -g start-it-cli
7878
```
7979

8080
### Local Installation
8181

8282
```bash
83-
npm uninstall start-it
83+
npm uninstall start-it-cli
8484
```
8585

8686
### Development Installation
8787

8888
```bash
89-
npm unlink start-it
89+
npm unlink start-it-cli
9090
```
9191

9292
## Troubleshooting
9393

9494
### Command not found
9595

96-
If you get "command not found: start-it" after global installation:
96+
If you get "command not found: start-it-cli" after global installation:
9797

9898
1. Check npm's global bin directory:
9999

@@ -118,7 +118,7 @@ export PATH="$(npm config get prefix)/bin:$PATH"
118118
If you get permission errors during global installation:
119119

120120
```bash
121-
sudo npm install -g start-it
121+
sudo npm install -g start-it-cli
122122
```
123123

124124
Or configure npm to avoid using sudo:
@@ -169,7 +169,7 @@ npm run build
169169
After installation, run:
170170

171171
```bash
172-
start-it
172+
start-it-cli
173173
```
174174

175175
And follow the interactive prompts to create your first project!

PROJECT_SUMMARY.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# start-it - Project Summary
1+
# start-it-cli - Project Summary
22

33
## Overview
44

5-
**start-it** is a comprehensive npm package that provides a prompt-based CLI tool for scaffolding projects across multiple frameworks and languages. It simplifies project initialization by offering interactive prompts and pre-configured templates.
5+
**start-it-cli** is a comprehensive npm package that provides a prompt-based CLI tool for scaffolding projects across multiple frameworks and languages. It simplifies project initialization by offering interactive prompts and pre-configured templates.
66

77
## Project Status
88

QUICK_START.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
# Quick Start Guide
22

3-
Get up and running with start-it in 2 minutes!
3+
Get up and running with start-it-cli in 2 minutes!
44

55
## Installation
66

77
```bash
8-
npm install -g start-it
8+
npm install -g start-it-cli
99
```
1010

1111
## Create Your First Project
1212

1313
```bash
14-
start-it
14+
start-it-cli
1515
```
1616

1717
Then answer the prompts:

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,21 +18,21 @@ A prompt-based CLI tool to scaffold projects for various frameworks and language
1818
## Installation
1919

2020
```bash
21-
npm install -g start-it
21+
npm install -g start-it-cli
2222
```
2323

2424
Or use with `npx`:
2525

2626
```bash
27-
npx start-it
27+
npx start-it-cli
2828
```
2929

3030
## Usage
3131

3232
Simply run the command:
3333

3434
```bash
35-
start-it
35+
start-it-cli
3636
```
3737

3838
Then follow the interactive prompts to:
@@ -45,7 +45,7 @@ Then follow the interactive prompts to:
4545
## Example
4646

4747
```bash
48-
$ start-it
48+
$ start-it-cli
4949
? What type of project would you like to create? (Use arrow keys)
5050
❯ Go
5151
Flutter

package.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "start-it",
2+
"name": "start-it-cli",
33
"version": "1.0.0",
44
"description": "A prompt-based CLI tool to scaffold projects for Go, Flutter, React Native, Spring Boot, and more",
55
"main": "dist/index.js",
@@ -42,5 +42,8 @@
4242
},
4343
"engines": {
4444
"node": ">=14.0.0"
45+
},
46+
"publishConfig": {
47+
"access": "public"
4548
}
4649
}

0 commit comments

Comments
 (0)