Create README.md

Project: http://git-wip-us.apache.org/repos/asf/ignite/repo
Commit: http://git-wip-us.apache.org/repos/asf/ignite/commit/31ddbae5
Tree: http://git-wip-us.apache.org/repos/asf/ignite/tree/31ddbae5
Diff: http://git-wip-us.apache.org/repos/asf/ignite/diff/31ddbae5

Branch: refs/heads/ignite-7777
Commit: 31ddbae53fbf650d19eda5f27aee3438b20c5e5a
Parents: 84aa349
Author: alexey-nbl <[email protected]>
Authored: Wed May 9 00:38:17 2018 +0300
Committer: GitHub <[email protected]>
Committed: Wed May 9 00:38:17 2018 +0300

----------------------------------------------------------------------
 modules/platforms/nodejs/spec/README.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/ignite/blob/31ddbae5/modules/platforms/nodejs/spec/README.md
----------------------------------------------------------------------
diff --git a/modules/platforms/nodejs/spec/README.md 
b/modules/platforms/nodejs/spec/README.md
new file mode 100644
index 0000000..a7eb1df
--- /dev/null
+++ b/modules/platforms/nodejs/spec/README.md
@@ -0,0 +1,19 @@
+# Test Instructions #
+
+NodeJS Client for Apache Ignite contains 
[Jasmine](https://www.npmjs.com/package/jasmine) tests in to check the client 
behavior.
+
+## Tests Installation ##
+
+(temporary, while the NPM module is not released on 
[npmjs](https://www.npmjs.com))
+
+Tests are installed along with the client.
+Follow the [instructions in the main readme](../README.md#installation).
+
+## Tests Running ##
+
+1. Run Apache Ignite server - locally or remotely.
+2. Set the environment variable:
+    - **APACHE_IGNITE_CLIENT_ENDPOINTS** - comma separated list of Ignite node 
endpoints.
+    - **APACHE_IGNITE_CLIENT_DEBUG** - (optional) if *true*, tests will 
display additional output (default: *false*).
+3. Alternatively, instead of the environment variables setting, you can 
directly specify the values of the corresponding variables in 
[local_ignite_path/modules/platforms/nodejspec/config.js](./config.js) file.
+4. Run the tests by calling `npm test` command from 
`local_ignite_path/modules/platforms/nodejs` folder.

Reply via email to