Updated README

Author: PMK744

README.md

@@ -0,0 +1,23 @@
+# Node-BEWSS
+
+## Minecraft Websockets
+Minecraft has websocket connection commands that may be used to connect to a websocket server. These commands are `/connect` and `/wsserver`.
+Both these commands have the same effect. Once connected to a websocket, the connection will last until the server closes it or until the
+player completely exits the game. The connection will last when a player merely leaves a world, and will thus last when joining a server.
+Websockets in Minecraft can be used for simple command communication between a player and a server. Additionally, the server can choose to
+listen for certain events sent by the client and act upon receiving them.
+
+In order to be able to execute the `/connect` and `/wsserver` commands, cheats must be enabled. This means that connecting on third party
+servers is not possible, and only on the dedicated server when cheats are enabled. It is possible to connect on a singleplayer world and
+join a server after that, but commands executed by the websocket server will not work. Events will still be sent by the client however.
+
+Node-BEWSS is based off of [mcwss](https://github.com/Sandertv/mcwss) but written in JavaScript.
+
+## Getting started
+
+  -   You need [Node.js](https://nodejs.org) v14.x and [npm](https://www.npmjs.com).
+  -   Download or clone the repository `git clone https://github.com/PMK744/node-mcwss.git`.
+  -   Install dependencies `npm install`
+  -   Before running production build you have to build it `npm run build`
+  -   You're done, you can run it using `npm run start` or `node .` (or `npm run dev` for development)
+  -   Check `src/index.ts` for basic usage examples.