Skip to content

Commit 66e1cc7

Browse files
committed
Readme
1 parent b99b31c commit 66e1cc7

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Websitino
2+
3+
A lightweight static file server for local development. Perfect for testing static websites and serving files with minimal setup.
4+
5+
## Features
6+
7+
- **Tiny footprint**: Only ~1.5MB, no external dependencies
8+
- **Zero installation**: Single portable executable
9+
- **Fast & efficient**: Built for performance
10+
- **Cross-platform**: Works on Linux, macOS and Windows
11+
- **Secure by default**: Hidden files/directories not served unless explicitly enabled
12+
13+
## Usage
14+
15+
Run `websitino` in your project directory to start serving files immediately.
16+
17+
To enable directory listing, use `websitino --list-dirs`. You can also use `websitino --index` to automatically serve index.html files when present in directories.
18+
19+
For a complete list of available options, run `websitino --help`.

0 commit comments

Comments
 (0)