Updated examples and added changelog

Author: dupski

CHANGELOG.md

@@ -0,0 +1,14 @@
+
+# json-to-graphql-query Changelog
+
+## 1.4.0
+
+* Added Variables support. Thanks @terion-name
+
+## 1.3.0
+
+* Added Alias support and made it possible to disable fields. Thanks @wellguimaraes
+
+## 1.2.0
+
+* Added Enum support, thanks @douglaseggleton

README.md

@@ -14,12 +14,15 @@ npm install json-to-graphql-query
 ## Features
 
  * Converts a JavaScript object to a GraphQL Query string
- * Full support for nested query nodes and arguments
- * Support for aliases via `__alias`
- * Support for input arguments via `__args`
- * Support for Enum values via `EnumType`
+ * Full support for nested query / mutation nodes and arguments
+ * Support for input arguments via [`__args`](#query-with-arguments)
+ * Support for query aliases via [`__alias`](#using-aliases)
+ * Support for Enum values via [`EnumType`](#query-with-enum-values)
+ * Support for variables via [`__variables`](#query-with-variables)
 
-See usage examples below :)
+## Recent Changes
+
+See the [CHANGELOG](CHANGELOG.md)
 
 ## Usage
 
@@ -57,18 +60,17 @@ query {
 }
 ```
 
-### Query with arguments
+### Query with arguments 
 
 ```typescript
-import { jsonToGraphQLQuery, EnumType } from 'json-to-graphql-query';
+import { jsonToGraphQLQuery } from 'json-to-graphql-query';
 
 const query = {
     query: {
         Posts: {
             __args: {
                 where: { id: 2 }
-                orderBy: 'post_date',
-                status: new EnumType('PUBLISHED')
+                orderBy: 'post_date'
             },
             id: true,
             title: true,
@@ -83,7 +85,7 @@ Resulting `graphql_query`
 
 ```graphql
 query {
-    Posts (where: {id: 2}, orderBy: "post_date", status: PUBLISHED) {
+    Posts (where: {id: 2}, orderBy: "post_date") {
         id
         title
         post_date
@@ -198,6 +200,72 @@ query {
 }
 ```
 
+### Query with Enum Values 
+
+```typescript
+import { jsonToGraphQLQuery, EnumType } from 'json-to-graphql-query';
+
+const query = {
+    query: {
+        Posts: {
+            __args: {
+                orderBy: 'post_date',
+                status: new EnumType('PUBLISHED')
+            },
+            title: true,
+            body: true
+        }
+    }
+};
+const graphql_query = jsonToGraphQLQuery(query, { pretty: true });
+```
+
+Resulting `graphql_query`
+
+```graphql
+query {
+    Posts (orderBy: "post_date", status: PUBLISHED) {
+        title
+        body
+    }
+}
+```
+
+### Query with variables 
+
+```typescript
+import { jsonToGraphQLQuery, VariableType } from 'json-to-graphql-query';
+
+const query = {
+    query: {
+        __variables: {
+            variable1: 'String!',
+            variableWithDefault: 'String = "default_value"'
+        },
+        Posts: {
+            __args: {
+                arg1: 20,
+                arg2: new VariableType('variable1')
+            },
+            id: true,
+            title: true
+        }
+    }
+};
+const graphql_query = jsonToGraphQLQuery(query, { pretty: true });
+```
+
+Resulting `graphql_query`
+
+```graphql
+query ($variable1: String!, $variableWithDefault: String = "default_value") {
+    Posts (arg1: 20, arg2: $variable1) {
+        id
+        title
+    }
+}
+```
+
 ## TO-DO List
 
  * Support Named Queries / Mutations