Browse Source

Docs: Add @deanshub as a contributor

pull/276/head
butlerx 4 years ago
parent
commit
5bf2535303
No known key found for this signature in database GPG Key ID: B37CA765BAA89170
  1. 9
      .all-contributorsrc
  2. 5
      README.md
  3. 24
      docs/README.md
  4. 2
      package.json
  5. 8
      yarn.lock

9
.all-contributorsrc

@ -307,6 +307,15 @@
"contributions": [
"code"
]
},
{
"login": "deanshub",
"name": "Dean Shub",
"avatar_url": "https://avatars2.githubusercontent.com/u/2688676?v=4",
"profile": "https://github.com/deanshub",
"contributions": [
"code"
]
}
],
"contributorsPerLine": 7

5
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-34-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->
@ -158,10 +158,11 @@ 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>
</tr>
</table>
<!-- markdownlint-enable -->
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->

24
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);
});
```

2
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>",

8
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"

Loading…
Cancel
Save