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/b9377b4d
Tree: http://git-wip-us.apache.org/repos/asf/ignite/tree/b9377b4d
Diff: http://git-wip-us.apache.org/repos/asf/ignite/diff/b9377b4d

Branch: refs/heads/ignite-7777
Commit: b9377b4d40a4e25dd50257ab6aa87f008bb91b50
Parents: 1363f36
Author: alexey-nbl <[email protected]>
Authored: Wed May 9 00:57:41 2018 +0300
Committer: GitHub <[email protected]>
Committed: Wed May 9 00:57:41 2018 +0300

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


http://git-wip-us.apache.org/repos/asf/ignite/blob/b9377b4d/modules/platforms/nodejs/examples/README.md
----------------------------------------------------------------------
diff --git a/modules/platforms/nodejs/examples/README.md 
b/modules/platforms/nodejs/examples/README.md
new file mode 100644
index 0000000..70245bc
--- /dev/null
+++ b/modules/platforms/nodejs/examples/README.md
@@ -0,0 +1,16 @@
+# Examples #
+
+NodeJS Client for Apache Ignite contains fully workable examples to 
demonstrate the main behavior of the client.
+
+## Examples Installation ##
+
+(temporary, while the NPM module is not released on 
[npmjs](https://www.npmjs.com))
+
+Examples are installed along with the client.
+Follow the [instructions in the main readme](../README.md#installation).
+
+## Examples Running ##
+
+1. Run Apache Ignite server - locally or remotely.
+2. If needed, modify `ENDPOINT` constant in an example source file - Ignite 
node endpoint. The default value is `127.0.0.1:10800`.
+3. Run an example by calling `node <example_file_name>.js`. Eg. `node 
CachePutGetExample.js`

Reply via email to