convert wetty from submodule to normal directory

This commit is contained in:
douboer@gmail.com
2026-03-03 16:07:18 +08:00
parent 1db76701a6
commit 0d185d2b3c
131 changed files with 15543 additions and 1 deletions

39
wetty/docs/README.md Normal file
View File

@@ -0,0 +1,39 @@
# Docs
![WeTTY](./terminal.png?raw=true)
- [AtoZ](./atoz.md)
- [Running as daemon](./service.md)
- [HTTPS Support](./https.md)
- [Using NGINX](./nginx.md)
- [Using Apache](./apache.md)
- [Automatic Login](./auto-login.md)
- [Downloading Files](./downloading-files.md)
- [Development Docs](./development.md)
## API
For WeTTY options and event details please refer to the [api docs](./API.md)
### Getting started
WeTTY is event driven. To Spawn a new server call `wetty.start()` with no
arguments.
```javascript
import { start } from 'wetty';
start(/* server settings, see Options */)
.then((wetty) => {
console.log('server running');
wetty
.on('exit', ({ code, msg }) => {
console.log(`Exit with code: ${code} ${msg}`);
})
.on('spawn', (msg) => console.log(msg));
/* code you want to execute */
})
.catch((err) => {
console.error(err);
});
```