You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tinkerpop.apache.org by GitBox <gi...@apache.org> on 2019/09/25 08:08:43 UTC
[GitHub] [tinkerpop] jorgebay commented on a change in pull request #1201:
TINKERPOP-2293 Improved landing pages for all GLVs
jorgebay commented on a change in pull request #1201: TINKERPOP-2293 Improved landing pages for all GLVs
URL: https://github.com/apache/tinkerpop/pull/1201#discussion_r327983429
##########
File path: gremlin-javascript/src/main/javascript/gremlin-javascript/README.md
##########
@@ -32,11 +32,39 @@ Gremlin-Javascript implements Gremlin within the JavaScript language and can be
npm install gremlin
```
+Gremlin-Javascript is designed to connect to a "server" that is hosting a TinkerPop-enabled graph system. That "server"
+could be [Gremlin Server][gs] or a [remote Gremlin provider][rgp] that exposes protocols by which Gremlin-Javascript
+can connect.
+
+A typical connection to a server running on "localhost" that supports the Gremlin Server protocol using websockets
+looks like this:
+
+```javascript
+const gremlin = require('gremlin');
+const traversal = gremlin.process.AnonymousTraversalSource.traversal;
+const DriverRemoteConnection = gremlin.driver.DriverRemoteConnection;
+
+const g = traversal().withRemote(new DriverRemoteConnection('ws://localhost:8182/gremlin'));
+```
+
+Once "g" has been established as a connection, it is then possible to start writing Gremlin traversals to query the
Review comment:
```suggestion
Once "g" has been created using a connection, it is then possible to start writing Gremlin traversals to query the
```
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services