diff --git a/.all-contributorsrc b/.all-contributorsrc index 6c4ee18..bf3a853 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -307,6 +307,70 @@ "contributions": [ "code" ] + }, + { + "login": "deanshub", + "name": "Dean Shub", + "avatar_url": "https://avatars2.githubusercontent.com/u/2688676?v=4", + "profile": "https://github.com/deanshub", + "contributions": [ + "code" + ] + }, + { + "login": "lozbrown", + "name": "lozbrown ", + "avatar_url": "https://avatars3.githubusercontent.com/u/9961593?v=4", + "profile": "https://github.com/lozbrown", + "contributions": [ + "code", + "example" + ] + }, + { + "login": "sergeir82", + "name": "sergeir82", + "avatar_url": "https://avatars0.githubusercontent.com/u/5081149?v=4", + "profile": "https://github.com/sergeir82", + "contributions": [ + "code" + ] + }, + { + "login": "kmlucy", + "name": "Kyle Lucy", + "avatar_url": "https://avatars1.githubusercontent.com/u/13952475?v=4", + "profile": "https://github.com/kmlucy", + "contributions": [ + "code" + ] + }, + { + "login": "userdocs", + "name": "userdocs", + "avatar_url": "https://avatars1.githubusercontent.com/u/16525024?v=4", + "profile": "https://github.com/userdocs", + "contributions": [ + "doc" + ] + }, + { + "login": "janoskk", + "name": "Janos Kasza", + "avatar_url": "https://avatars3.githubusercontent.com/u/1554533?v=4", + "profile": "https://logmein.com/", + "contributions": [ + "code" + ] + }, + { + "login": "DefunctLizard", + "name": "Grant Handy", + "avatar_url": "https://avatars3.githubusercontent.com/u/45475651?v=4", + "profile": "https://grantshandy.xyz/", + "contributions": [ + "doc" + ] } ], "contributorsPerLine": 7 diff --git a/README.md b/README.md index a6a2cad..847002e 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ -[![All Contributors](https://img.shields.io/badge/all_contributors-33-orange.svg?style=flat-square)](#contributors-) +[![All Contributors](https://img.shields.io/badge/all_contributors-40-orange.svg?style=flat-square)](#contributors-) @@ -14,6 +14,8 @@ > Terminal access in browser over http/https +![WeTTy](./docs/terminal.png?raw=true) + Terminal over HTTP and https. WeTTy is an alternative to ajaxterm and anyterm but much better than them because WeTTy uses xterm.js which is a full fledged implementation of terminal emulation written entirely in JavaScript. WeTTy uses @@ -158,10 +160,19 @@ Thanks goes to these wonderful people
Farhan Khan

💻
Jurre Vriesen

💻
James Turnbull

💻 +
Dean Shub

💻 +
lozbrown

💻 💡 + + +
sergeir82

💻 +
Kyle Lucy

💻 +
userdocs

📖 +
Janos Kasza

💻 +
Grant Handy

📖 - + diff --git a/docs/README.md b/docs/README.md index 5c664fb..c2b785f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -20,15 +20,19 @@ WeTTy is event driven. To Spawn a new server call `wetty.start()` with no arguments. ```javascript -const wetty = require('wetty.js'); - -wetty - .on('exit', ({ code, msg }) => { - console.log(`Exit with code: ${code} ${msg}`); +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 */ }) - .on('spawn', msg => console.log(msg)); -wetty.start(/* server settings, see Options */).then(() => { - console.log('server running'); - /* code you want to execute */ -}); + .catch((err) => { + console.error(err); + }); ``` diff --git a/package.json b/package.json index 3202ca1..e0739c9 100644 --- a/package.json +++ b/package.json @@ -158,7 +158,7 @@ "sinon": "^7.5.0", "snowpack": "^2.10.1", "ts-node": "^9.0.0", - "typescript": "^4.0.2" + "typescript": "^4.0.3" }, "contributors": [ "Krishna Srinivas ", diff --git a/yarn.lock b/yarn.lock index 549b297..563a7e5 100644 --- a/yarn.lock +++ b/yarn.lock @@ -5514,10 +5514,10 @@ typedarray-to-buffer@^3.1.5: dependencies: is-typedarray "^1.0.0" -typescript@^4.0.2: - version "4.0.2" - resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.0.2.tgz#7ea7c88777c723c681e33bf7988be5d008d05ac2" - integrity sha512-e4ERvRV2wb+rRZ/IQeb3jm2VxBsirQLpQhdxplZ2MEzGvDkkMmPglecnNDfSUBivMjP93vRbngYYDQqQ/78bcQ== +typescript@^4.0.3: + version "4.0.3" + resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.0.3.tgz#153bbd468ef07725c1df9c77e8b453f8d36abba5" + integrity sha512-tEu6DGxGgRJPb/mVPIZ48e69xCn2yRmCgYmDugAVwmJ6o+0u1RI18eO7E7WBTLYLaEVVOhwQmcdhQHweux/WPg== undefsafe@^2.0.2: version "2.0.3"