graphql-apollo-client 1.0.0 → 1.0.1

package/README.md

@@ -1,9 +1,65 @@
-# GraphqQL WebSocket Client
+# graphql-apollo-client
 
+Helpful utility that will make your development process faster. This can be used in any library. Basically nodejs based.
 
-### To Install dependencies
-- `npm install` or `yarn`
+### Install Package
+```bash 
+npm install graphql-apollo-client --save 
+```
+or
+```bash
+yarn add graphql-apollo-client
+```
 
-### To run this example:
 
-- `npm run dev` or `yarn dev`
+### Example
+
+```js
+import configureClient from 'graphql-apollo-client';
+
+const client = configureClient({
+  httpEndpoint, 
+  wsEndpoint, 
+  bearerToken
+})
+`
+```
+
+The above code is to configure client. Now it's time to use this client
+Note: To define query you need to install graphql-tag to use `gql`
+
+```js
+import { gql } from 'graphql-tag';
+
+client
+  .query({
+    query: gql`
+      query Books {
+        books {
+          title
+          author
+        }
+      }
+    `,
+    variables: {},
+  })
+  .then(console.log)
+
+client
+ .subscribe({
+   query: gql`
+     subscription {
+       realtimeMeasurement(deviceId: "pM8SEyRQ") {
+         activePowerImport
+         time
+       }
+     }
+   `,
+   variables: {}
+ })
+ .subscribe({
+   next(data) {
+     console.log(data);
+   }
+ });
+ ```

package/index.js

@@ -61,36 +61,38 @@ const configureClient = ({ httpEndpoint, wsEndpoint, bearerToken }) => {
 
 /**
  * Example
+ * const GRAPHQL_ENDPOINT = "https://api.ecomon.no";
+ * const GRAPHQL_ENDPOINT_WS = "wss://api.ecomon.no";
+ * const TOKEN = "Bearer intermediary-api-key_858bef2f-5b67-49b2-b7e0-c07a093f98be";
+ * 
+ * const client = configureClient({
+ *  httpEndpoint: GRAPHQL_ENDPOINT,
+ *  wsEndpoint: GRAPHQL_ENDPOINT_WS,
+ *  bearerToken: TOKEN
+ * })
+ * 
+ * // Test subscription
+ * client
+ * .subscribe({
+ *   query: gql`
+ *     subscription {
+ *       realtimeMeasurement(deviceId: "pM8SEyRQ") {
+ *         activePowerImport
+ *         time
+ *       }
+ *     }
+ *   `,
+ *   variables: {}
+ * })
+ * .subscribe({
+ *   next(data) {
+ *     console.log(data);
+ *   }
+ * });
+ * 
  */
 
-const GRAPHQL_ENDPOINT = "https://api.ecomon.no";
-const GRAPHQL_ENDPOINT_WS = "wss://api.ecomon.no";
-const TOKEN = "Bearer intermediary-api-key_858bef2f-5b67-49b2-b7e0-c07a093f98be";
-
-const client = configureClient({
-  httpEndpoint: GRAPHQL_ENDPOINT,
-  wsEndpoint: GRAPHQL_ENDPOINT_WS,
-  bearerToken: TOKEN
-})
 
-// Test subscription
-client
-  .subscribe({
-    query: gql`
-      subscription {
-        realtimeMeasurement(deviceId: "pM8SEyRQ") {
-          activePowerImport
-          time
-        }
-      }
-    `,
-    variables: {}
-  })
-  .subscribe({
-    next(data) {
-      console.log(data);
-    }
-  });
 
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "graphql-apollo-client",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "main": "index.js",
   "license": "MIT",
   "dependencies": {
@@ -25,4 +25,4 @@
   },
   "keywords": [],
   "description": ""
-}
+}