Merge pull request #276 from butlerx/docs

.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

README.md

@@ -2,7 +2,7 @@
 
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
 
-[![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-)
 
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
@@ -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
     <td align="center"><a href="https://mastodon.technology/@farhan"><img src="https://avatars1.githubusercontent.com/u/10103765?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Farhan Khan</b></sub></a><br /><a href="https://github.com/butlerx/WeTTy/commits?author=khanzf" title="Code">💻</a></td>
     <td align="center"><a href="https://www.jurrevriesen.nl"><img src="https://avatars1.githubusercontent.com/u/7419259?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Jurre Vriesen</b></sub></a><br /><a href="https://github.com/butlerx/WeTTy/commits?author=jurruh" title="Code">💻</a></td>
     <td align="center"><a href="https://www.kartar.net/"><img src="https://avatars3.githubusercontent.com/u/4365?v=4?s=100" width="100px;" alt=""/><br /><sub><b>James Turnbull</b></sub></a><br /><a href="https://github.com/butlerx/WeTTy/commits?author=jamtur01" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/deanshub"><img src="https://avatars2.githubusercontent.com/u/2688676?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Dean Shub</b></sub></a><br /><a href="https://github.com/butlerx/WeTTy/commits?author=deanshub" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/lozbrown"><img src="https://avatars3.githubusercontent.com/u/9961593?v=4?s=100" width="100px;" alt=""/><br /><sub><b>lozbrown </b></sub></a><br /><a href="https://github.com/butlerx/WeTTy/commits?author=lozbrown" title="Code">💻</a> <a href="#example-lozbrown" title="Examples">💡</a></td>
+  </tr>
+  <tr>
+    <td align="center"><a href="https://github.com/sergeir82"><img src="https://avatars0.githubusercontent.com/u/5081149?v=4?s=100" width="100px;" alt=""/><br /><sub><b>sergeir82</b></sub></a><br /><a href="https://github.com/butlerx/WeTTy/commits?author=sergeir82" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/kmlucy"><img src="https://avatars1.githubusercontent.com/u/13952475?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Kyle Lucy</b></sub></a><br /><a href="https://github.com/butlerx/WeTTy/commits?author=kmlucy" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/userdocs"><img src="https://avatars1.githubusercontent.com/u/16525024?v=4?s=100" width="100px;" alt=""/><br /><sub><b>userdocs</b></sub></a><br /><a href="https://github.com/butlerx/WeTTy/commits?author=userdocs" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://logmein.com/"><img src="https://avatars3.githubusercontent.com/u/1554533?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Janos Kasza</b></sub></a><br /><a href="https://github.com/butlerx/WeTTy/commits?author=janoskk" title="Code">💻</a></td>
+    <td align="center"><a href="https://grantshandy.xyz/"><img src="https://avatars3.githubusercontent.com/u/45475651?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Grant Handy</b></sub></a><br /><a href="https://github.com/butlerx/WeTTy/commits?author=DefunctLizard" title="Documentation">📖</a></td>
   </tr>
 </table>
 
-<!-- markdownlint-enable -->
+<!-- markdownlint-restore -->
 <!-- prettier-ignore-end -->
 
 <!-- ALL-CONTRIBUTORS-LIST:END -->

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');
+import { start } from 'wetty';
 
-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));
+      .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);
+  });
 ```

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 <krishna.srinivas@gmail.com>",

yarn.lock

@@ -5514,10 +5514,10 @@ typedarray-to-buffer@^3.1.5:
   dependencies:
     is-typedarray "^1.0.0"
 
-typescript@^4.0.2:
+typescript@^4.0.3:
-  version "4.0.2"
+  version "4.0.3"
-  resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.0.2.tgz#7ea7c88777c723c681e33bf7988be5d008d05ac2"
+  resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.0.3.tgz#153bbd468ef07725c1df9c77e8b453f8d36abba5"
-  integrity sha512-e4ERvRV2wb+rRZ/IQeb3jm2VxBsirQLpQhdxplZ2MEzGvDkkMmPglecnNDfSUBivMjP93vRbngYYDQqQ/78bcQ==
+  integrity sha512-tEu6DGxGgRJPb/mVPIZ48e69xCn2yRmCgYmDugAVwmJ6o+0u1RI18eO7E7WBTLYLaEVVOhwQmcdhQHweux/WPg==
 
 undefsafe@^2.0.2:
   version "2.0.3"