Merge branch 'feature/new-example-readmes' of github.com:nymtech/nym into feature/new-example-readmes

* consolidated readmes into one root readme with info on the examples

clients/native/README.md

@@ -1,3 +1,4 @@
 # Nym Desktop Client
 
 The Nym Desktop Client communicates with the remote, decentralised nodes which make up the Nym system as a whole. 
+

clients/native/examples/README.md

@@ -0,0 +1,48 @@
+# Nym Desktop Client Code Examples 
+
+This directory contains example code for javascript, python, and rust. Please note that **none of these examples are production-ready**, and are included really just to show how the client interacts with the Nym system. 
+
+> Make sure that you have an instance of the `nym-client` set up and running locally on port 1977 before trying to run any of these examples. 
+
+## Go
+There are two examples here: 
+* `binarysend`, which (as the name suggests) sends a binary file, and 
+* `textsend` which sends a raw text file. 
+
+Both examples send these files over the Nym mixnet to the address of your running Nym client, logging information in your terminal window. 
+
+## Javascript 
+The example included here starts a websocket server on port 8888, the ui of which can be used to send strings over the Nym mixnet to the address of your running Nym client. 
+
+### Prerequisites
+* Reasonably up to date `NodeJS` & `npm` (>= ~v12)
+
+### Running it
+Run the following commands:
+
+```
+# install dependencies
+npm install
+# start a webserver on port 8888 
+npm start 
+```
+
+Then open your browser to `localhost:8888`. 
+
+## Python 
+There are two examples here: 
+* `binarysend`, which (as the name suggests) sends a binary file, and 
+* `textsend` which sends a raw text file. 
+
+Both examples send these files over the Nym mixnet to the address of your running Nym client, logging information in your terminal window. 
+
+Make sure that you have an instance of the `nym-client` set up and running locally on port 1977 before trying to run either of the example scripts. 
+
+## Rust 
+There are two examples here: 
+* `binarysend`, which (as the name suggests) sends a binary file, and 
+* `textsend` which sends a raw text file. 
+
+Both examples send these files over the Nym mixnet to the address of your running Nym client, logging information in your terminal window. 
+
+Make sure that you have an instance of the `nym-client` set up and running locally on port 1977 before trying to run either of the example scripts. 

clients/native/examples/js-examples/websocket/README.md

@@ -1,10 +0,0 @@
-### Prerequisites
-
-* Reasonably up to date Node + `npm`
-
-### Running it
-
-```
-npm install 
-npm start # starts a webserver on port 8888
-```

clients/native/examples/js-examples/websocket/package.json

@@ -26,6 +26,7 @@
   },
   "dependencies": {
     "core-js": "^3.6.5",
-    "html-webpack-plugin": "^4.2.0"
+    "html-webpack-plugin": "^4.2.0",
+    "postcss": "^8.4.5"
   }
 }

clients/native/examples/rust-examples/dummy_file

@@ -0,0 +1,9 @@
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam quis efficitur neque. Quisque aliquet vulputate ante, eget vehicula odio feugiat ac. Nulla ut mattis magna. Aenean tincidunt quis nulla eget eleifend. Cras in pretium sem. Nunc lorem metus, blandit sit amet egestas ut, feugiat quis tellus. Aenean tristique, enim a tincidunt condimentum, eros est blandit nunc, id viverra metus erat at nulla. Vivamus at tellus sodales, feugiat odio vel, laoreet neque. Vivamus posuere nulla ac sodales bibendum.
+
+Vestibulum pulvinar nisi non ultricies egestas. Integer finibus ultrices justo vitae suscipit. Etiam interdum eu justo vel interdum. Morbi sagittis ac nisl quis consequat. Mauris dapibus ut risus ac facilisis. Pellentesque non tortor feugiat, consectetur arcu vel, ullamcorper sapien. Proin sodales purus non orci bibendum, sit amet ultrices justo ullamcorper. Nullam ac risus ac justo ultricies efficitur auctor nec arcu. Etiam sed finibus felis. Suspendisse potenti. Phasellus malesuada velit ac ullamcorper egestas. Sed elementum diam ut est gravida ultricies.
+
+Pellentesque sed metus massa. Cras imperdiet lacus sit amet dolor aliquam, luctus posuere justo hendrerit. Morbi augue ex, gravida a metus sed, scelerisque euismod lacus. Nam consequat sapien ac pellentesque sagittis. Morbi a ultrices massa, vel aliquet ex. Maecenas ac sem diam. Nunc sed erat et ipsum volutpat auctor. Etiam elit felis, commodo vitae ipsum ac, fermentum lobortis arcu. Aliquam eu tempus enim. Curabitur vulputate imperdiet aliquam. Morbi iaculis rhoncus risus at malesuada. Donec accumsan feugiat ligula ut facilisis. Nunc porttitor sit amet est eget malesuada. Sed sed consectetur augue, non dapibus orci. Mauris aliquam pellentesque quam, sit amet pellentesque velit cursus vitae. Morbi sit amet molestie risus.
+
+Nam gravida non ligula a egestas. Fusce sodales, purus id rhoncus mattis, purus est vehicula urna, vel finibus augue velit et est. Donec dictum erat eleifend lobortis iaculis. Praesent id venenatis ante. Donec feugiat, ipsum eget porttitor pulvinar, nisl odio posuere lorem, ut placerat elit nulla a ligula. Suspendisse nec nibh tincidunt, sollicitudin mi a, volutpat ligula. In maximus quam lacus, eget semper dolor sagittis sit amet.
+
+In vitae hendrerit est, quis facilisis dui. In eu ante enim. Nullam hendrerit odio sit amet odio tincidunt eleifend. Aliquam erat volutpat. Curabitur commodo, purus pharetra lobortis rhoncus, tortor massa imperdiet nisl, vel dignissim tortor sem at orci. Aliquam maximus lobortis lacus, eu porttitor purus dapibus ut. Praesent at dapibus felis, efficitur blandit tortor. In hac habitasse platea dictumst. Aenean ultrices, nisl a pretium sagittis, tellus sapien mollis erat, eu consectetur erat mauris sed libero. Duis feugiat dapibus mi, vel ornare velit vehicula mattis. Ut suscipit pharetra leo et sollicitudin.