Merge wscat2

.gitignore

@@ -0,0 +1,3 @@
+node_modules
+lib
+test/testfile*

.travis.yml

@@ -0,0 +1,6 @@
+language: node_js
+node_js:
+  - "8"
+  - "10"
+  - "11"
+  - "12"

LICENSE

@@ -0,0 +1,11 @@
+Copyright 2017 Johan Nordberg <[email protected]>
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Makefile

@@ -0,0 +1,37 @@
+
+SHELL := /bin/bash
+PATH  := ./node_modules/.bin:$(PATH)
+
+SRC_FILES := $(shell find src -name '*.ts')
+
+.PHONY: all
+all: lib
+
+.PHONY: test
+test: node_modules
+	tslint -p tsconfig.json -c tslint.json && \
+	./test/cli.sh
+
+.PHONY: lint
+lint: node_modules
+	tslint -p tsconfig.json -c tslint.json -t stylish --fix
+
+lib: $(SRC_FILES) node_modules
+	tsc -p tsconfig.json && \
+	sed -i "" "1s/ts-node/node/" lib/cli.js && \
+	rm lib/cli.d.ts && \
+	VERSION="$$(node -p 'require("./package.json").version')"; \
+	echo "exports.default = '$${VERSION}';" > lib/version.js && \
+	touch lib
+
+node_modules:
+	npm ci && \
+	touch node_modules
+
+.PHONY: clean
+clean:
+	rm -rf lib/
+
+.PHONY: distclean
+distclean: clean
+	rm -rf node_modules/

README.md

@@ -1,26 +1,141 @@
-# wscat
 
-WebSocket cat.
+wscat2 [![Build Status](https://travis-ci.org/jnordberg/wscat.svg?branch=master)](https://travis-ci.org/jnordberg/wscat)
+======
 
-## Installation
+Unix-style WebSocket cat (or netcat for websockets).
 
-This module needs to be installed globally so use the `-g` flag when installing:
+
+Installation
+------------
+
+```
+npm install -g wscat2
+```
+
+
+Usage
+-----
+
+```
+$ wscat -h
+usage: wscat [-h] [-v] [-l PORT] [-b] [-H HEADER] [-n] [-k] [-d] [-s SUBP] [address]
+
+Positional arguments:
+  address
+
+Optional arguments:
+  -h, --help            Show this help message and exit.
+  -v, --version         Show program's version number and exit.
+  -l PORT, --listen PORT
+                        Start a websocket server on PORT.
+  -b, --binary          Use binary WebSockets.
+  -H HEADER, --header HEADER
+                        Specify a custom HTTP request header. May be given
+                        multiple times.
+  -n, --no-check        Do not check for unauthorized certificates.
+  -k, --keep-open       Do not close the socket after EOF.
+  -d, --deflate         Use per-message deflate.
+  -s SUBP, --subprotocol SUBP
+                        WebSocket subprotocol
+```
+
+
+Examples
+--------
+
+If you ever used `nc`, `wscat` works pretty much the same.
+
+### Connect to a server
+
+```
+$ wscat echo.websocket.org
+Hello
+Hello
+Who's there?
+Who's there?
+^D
+
+```
+
+### Chat
+
+Server:
+
+```
+$ wscat -l 12345
+Hi there!
+Hi!
+It's nice to speak to someone who just dosn't repeat everything I say back at me.
+Yeah! Isn't it?!
+Sorry, gotta run...
+^D
+
+```
+
+Client:
+
+```
+$ wscat localhost:12345
+Hi there!
+Hi!
+It's nice to speak to someone who just dosn't repeat everything I say back at me.
+Yeah! Isn't it?!
+Sorry, gotta run...
+```
+
+### Transfer a file
+
+Server:
+
+```
+$ wscat -b -l 12345 < ~/Desktop/mycat.jpg
+```
+
+Client:
 
 ```
-npm install -g wscat
+$ wscat -b localhost:12345 > igotacat.jpg
 ```
 
-## Usage
+Note that you can have the client send the file as well, after the connection has been setup `wscat` does not differentiate between server/client.
+
+### Get your bitcoin on
 
 ```
-$ wscat -c ws://echo.websocket.org 
-connected (press CTRL+C to quit)
-> hi there
-< hi there
-> are you a happy parrot?
-< are you a happy parrot?
+$ echo '{"op":"unconfirmed_sub"}' | wscat -k wss://ws.blockchain.info/inv
 ```
 
-## License
+The `-k` option is used to keep the socket open after the command has been sent, allowing us to read the continuous stream of Bitcoin transactions.
 
-MIT
+
+Developing
+----------
+
+This node.js program is written in TypeScript and has a compile step that you can run with `make lib`. For developing it is convenient to install the `ts-node` and `typescript` modules  globally (`npm i -g ..`), this will allow you to directly execute the programs entry-point: `./src/cli.ts`.
+
+Use `make test` to run the tests and lint check and `make lint` to run the linter in formatter mode.
+
+
+License
+-------
+
+[BSD 3-Clause](https://tldrlegal.com/license/bsd-3-clause-license-(revised))
+
+---
+
+```
+
+       /\_/\                    /\_/\
+      / 0 0 \                  / o o \
+     ====v====                ====C====          __   __
+      \  W  /                  \  V  /         _(  )_(  )_
+      |     |     _            |     |     .-=(_   WEB  _)
+      / ___ \    /             / ___ \    /     (__   __)
+     / /   \ \  |             / /   \ \  |        (__)
+    (((-----)))-'            (((-----)))-'
+     /                        /
+    (      ___      ___      /
+     \__.=|___|E    3__|=.__/
+            /       ^
+
+```