SUPPO-1256: Finalize example running instructions. Stray notes for DEVELOPER.md

Author: seth-mg

DEVELOPER.md

@@ -0,0 +1,43 @@
+## Binding Developer Info
+
+#### Build and Release Instructions
+TBD
+Include notes on updating Travis test versions, keeping `package.json` fresh.
+Maybe some notes on updating dependency versions, linting, dependency vulnerabilities, etc.
+There appears to be some mixed whitespace that should be tidied up.
+
+
+#### Old Docker Info From Examples
+If we want to keep this, let's clean it up.
+
+`runAll.sh` is testing a string instead of an http code.
+`runAl.sh` and `Dockerfile` may need to be consolidated with the other example scripts.
+
+Here are the old instructions from examples/README.
+
+##### Docker
+A Docker image for running the examples against the compiled source library is available on Docker Hub.
+
+Command: `docker run -e API_KEY=api-key -v "<binding root directory>:/source" rosetteapi/docker-nodejs`
+
+Additional environment settings:
+`-e ALT_URL=<alternative URL>`
+`-e FILENAME=<single filename>`
+
+##### Example using the Rosette API language detection endpoint
+```javascript
+var Api = require('rosette-api');
+
+var api = new Api(API_KEY);
+var endpoint = "language";
+var content = "Por favor Señorita, says the man.";
+api.parameters.content = content;
+
+api.rosette(endpoint, function(err, res){
+		      if(err){
+			console.log(err);
+			} else {
+			  console.log(JSON.stringify(res, null, 2));
+			  }
+});
+```

examples/README.md

@@ -1,30 +1,29 @@
 ## Endpoint Examples
-
 Each example file demonstrates one of the capabilities of the Rosette Platform.
 
-## Docker ##
-A Docker image for running the examples against the compiled source library is available on Docker Hub.
-
-Command: `docker run -e API_KEY=api-key -v "<binding root directory>:/source" rosetteapi/docker-nodejs`
-
-Additional environment settings:
-`-e ALT_URL=<alternative URL>`
-`-e FILENAME=<single filename>`
+Here are some methods for running the examples. Each example will also accept an optional `--url` parameter for
+overriding the default URL.
 
-## Example using the Rosette API language detection endpoint
-```javascript
-var Api = require('rosette-api');
+A note on prerequisites. Rosette API only supports TLS 1.2 so ensure your toolchain also supports it.
 
-var api = new Api(API_KEY);
-var endpoint = "language";
-var content = "Por favor Señorita, says the man.";
-api.parameters.content = content;
+#### Docker/Latest Release
+```
+git clone [email protected]:rosette-api/nodejs.git
+cd nodejs/examples
+docker run -it --entrypoint sh -v $(pwd):/examples node:12-alpine
+cd /examples
+npm install rosette-api argparse
+sed -i s',require("../lib/Api"),require("rosette-api"),' ping.js
+node ping.js --key $API_KEY
+```
 
-api.rosette(endpoint, function(err, res){
-		      if(err){
-			console.log(err);
-			} else {
-			  console.log(JSON.stringify(res, null, 2));
-			  }
-});
-```
+#### Docker/Current Source
+```
+git clone [email protected]:rosette-api/nodejs.git
+cd nodejs
+docker run -it --entrypoint sh -v $(pwd):/source node:12-alpine
+cd /source
+npm install
+cd examples
+node ping.js --key $API_KEY
+```