Skip to content

Commit 3e64c8c

Browse files
committed
fix: update package name to include scope in README and package.json
1 parent 6445ee6 commit 3e64c8c

File tree

2 files changed

+8
-3
lines changed

2 files changed

+8
-3
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ The open-source Mintlify alternative. Beautiful documentation sites from Markdow
1717
### Global Installation
1818

1919
```bash
20-
npm install -g superdocs
20+
npm install -g @devrohit06/superdocs
2121
# or
22-
pnpm add -g superdocs
22+
pnpm add -g @devrohit06/superdocs
2323
```
2424

2525
### Local Development
@@ -41,13 +41,15 @@ superdocs build --input ./my-docs --output ./dist
4141
```
4242

4343
**Options:**
44+
4445
- `-i, --input <path>` (required) - Path to your docs folder
4546
- `-o, --output <path>` - Output directory (default: `./dist`)
4647
- `-t, --theme <name>` - Theme to use (`default`, `dark`)
4748
- `-b, --base-url <url>` - Base URL for the site (default: `/`)
4849
- `--search` - Enable search functionality
4950

5051
**Example:**
52+
5153
```bash
5254
superdocs build \
5355
--input ./docs \
@@ -66,13 +68,15 @@ superdocs dev --input ./my-docs
6668
```
6769

6870
**Options:**
71+
6972
- `-i, --input <path>` (required) - Path to your docs folder
7073
- `-t, --theme <name>` - Theme to use
7174
- `-b, --base-url <url>` - Base URL for the site
7275
- `-p, --port <number>` - Port for dev server (default: `4321`)
7376
- `--search` - Enable search functionality
7477

7578
**Example:**
79+
7680
```bash
7781
superdocs dev --input ./docs --port 3000
7882
```
@@ -86,6 +90,7 @@ superdocs eject --input ./my-docs --output ./my-project
8690
```
8791

8892
**Options:**
93+
8994
- `-i, --input <path>` (required) - Path to your docs folder
9095
- `-o, --output <path>` - Output directory for the project (default: `./astro-docs-project`)
9196
- `-t, --theme <name>` - Theme to use

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "superdocs",
2+
"name": "@devrohit06/superdocs",
33
"version": "0.1.0",
44
"description": "The open-source Mintlify alternative. Beautiful documentation sites from Markdown.",
55
"main": "src/index.js",

0 commit comments

Comments
 (0)