diff options
| author | Holden Rohrer <holden.rohrer@gmail.com> | 2019-12-18 16:42:06 -0500 |
|---|---|---|
| committer | Holden Rohrer <holden.rohrer@gmail.com> | 2019-12-18 16:42:06 -0500 |
| commit | 057ccc9d8a84b9bc8673c1d387a422e3cc74190d (patch) | |
| tree | 66eae978bc519b9b04ccdf67861307e3a76cd7a2 | |
| parent | fae8f6b3bbb1fd18cd07c26673d454a8136c093f (diff) | |
added how-to section of README
| -rw-r--r-- | README.md | 12 |
1 files changed, 11 insertions, 1 deletions
@@ -2,7 +2,17 @@ A reconstructed version of `ywot-bot` built off of clean programming principles and a minimal, but fast API. -# Features +## Getting Started + +To download and run this library, install node.js and npm, if you haven't already, and run: +```bash +git clone https://github.com/feynmansfedora/ywot-clean.git +cd ywot-clean +npm i +node examples/helloworld.js # To try out the hello world (read the code for more detail) +``` + +## Features Currently, `socket.js` provides `Socket` which has a few signals and functions (documented in the code, of course) which allow abstracted interfacing with YWOT. However, certain facilities available in the old version like queuing or fetch division were scrapped in favor of more direct limits due to the unmaintainability of the old style. |