Skip to content

Commit cda81e1

Browse files
docs: update README with servejss package name
1 parent 01cac15 commit cda81e1

File tree

1 file changed

+20
-20
lines changed

1 file changed

+20
-20
lines changed

README.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# jsserve
1+
# servejss
22

33
> Static file server with REST write support. A drop-in `npx serve` alternative.
44
5-
[![npm version](https://img.shields.io/npm/v/jsserve.svg)](https://www.npmjs.com/package/jsserve)
5+
[![npm version](https://img.shields.io/npm/v/servejss.svg)](https://www.npmjs.com/package/servejss)
66
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
77

88
## Why?
@@ -14,43 +14,43 @@
1414
- Sync files between devices on your LAN
1515
- Have a simple WebDAV-like server
1616

17-
**jsserve** is `serve` with superpowers: same simple interface, but you can write too.
17+
**servejss** is `serve` with superpowers: same simple interface, but you can write too.
1818

1919
## Install
2020

2121
```bash
22-
npm install -g jsserve
22+
npm install -g servejss
2323
```
2424

2525
Or use directly with npx:
2626

2727
```bash
28-
npx jsserve
28+
npx servejss
2929
```
3030

3131
## Usage
3232

3333
```bash
3434
# Serve current directory (read + write enabled)
35-
jsserve
35+
servejss
3636

3737
# Serve specific directory
38-
jsserve ./public
38+
servejss ./public
3939

4040
# Custom port
41-
jsserve -p 8080
41+
servejss -p 8080
4242

4343
# Specify port and directory
44-
jsserve -l 3000 ./dist
44+
servejss -l 3000 ./dist
4545

4646
# Read-only mode (exactly like npx serve)
47-
jsserve --read-only
47+
servejss --read-only
4848
```
4949

5050
## Output
5151

5252
```
53-
jsserve
53+
servejss
5454
5555
Directory: /home/user/project
5656
@@ -84,7 +84,7 @@ curl -X PUT -H 'If-None-Match: *' -d "New file" http://localhost:3000/new.txt
8484
## Options
8585

8686
```
87-
Usage: jsserve [options] [directory]
87+
Usage: servejss [options] [directory]
8888
8989
Options:
9090
-v, --version Output version number
@@ -109,7 +109,7 @@ Options:
109109

110110
## Comparison with serve
111111

112-
| Feature | serve | jsserve |
112+
| Feature | serve | servejss |
113113
|---------|-------|---------|
114114
| Static file serving |||
115115
| Directory listings |||
@@ -128,7 +128,7 @@ Options:
128128

129129
### Conditional Requests
130130

131-
jsserve supports ETags for efficient caching and safe concurrent updates:
131+
servejss supports ETags for efficient caching and safe concurrent updates:
132132

133133
```bash
134134
# Get a file with its ETag
@@ -145,10 +145,10 @@ curl -X PUT -H 'If-Match: "a1b2c3"' -d "new content" http://localhost:3000/file.
145145

146146
### Upgrade to Solid
147147

148-
jsserve is powered by [JSS (JavaScript Solid Server)](https://github.com/JavaScriptSolidServer/JavaScriptSolidServer). Enable full Solid protocol support:
148+
servejss is powered by [JSS (JavaScript Solid Server)](https://github.com/JavaScriptSolidServer/JavaScriptSolidServer). Enable full Solid protocol support:
149149

150150
```bash
151-
jsserve --solid
151+
servejss --solid
152152
```
153153

154154
This enables:
@@ -163,25 +163,25 @@ This enables:
163163
```bash
164164
# Serve your project with write support for uploads
165165
cd my-project
166-
jsserve
166+
servejss
167167
```
168168

169169
### Quick File Sharing on LAN
170170
```bash
171171
# Share files with devices on your network
172-
jsserve --read-only ~/shared-files
172+
servejss --read-only ~/shared-files
173173
```
174174

175175
### REST API Testing
176176
```bash
177177
# Mock a simple REST backend
178-
jsserve ./mock-data
178+
servejss ./mock-data
179179
```
180180

181181
### WebDAV Alternative
182182
```bash
183183
# Lightweight file sync server
184-
jsserve --auth user:pass ~/sync
184+
servejss --auth user:pass ~/sync
185185
```
186186

187187
## License

0 commit comments

Comments
 (0)