graphql-connect - npm Package Compare versions

Comparing version 1.0.3 to 1.0.4

package.json

 {
   "name": "graphql-connect",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "GraphQL tool for easily connecting to remote graphql services",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

 # graphql-connect
-GraphQL tool that makes for easy remote schema connections
+GraphQL tool that makes for easy remote schema connections and merging multiple schemas into one.
+
+### Get Started
+ - Install `npm install graphql-connect`
+ - Import `const { createRemoteSchema, mergeSchemas } = require('graphql-connect');`
+
+#### Connect Remote Schema
+```
+const remoteSchema = createRemoteSchema({
+  uri: 'localhost:8080/graphql'
+});
+```
+
+#### Merge Multiple Schemas Into One
+```
+ const schemas = await mergeSchemas({ schemas: [remoteSchema] });
+```
+
+#### Example
+```
+import { createRemoteSchema, mergeSchemas } from 'graphql-connect';
+
+// Local Schemas
+import cmsSchema from './schemas/cms';
+
+export default async userToken => {
+	// Remote Schemas
+	const userSchema = createRemoteSchema({
+		uri: process.env.user,
+		headers: {
+			'X-Auth': userToken,
+			Authorization: process.env.user_secret
+		}
+	});
+
+	// Return both schemas merged into one
+	return await mergeSchemas({ schemas: [userSchema, cmsSchema] });
+};
+
+```
+
+#### Contributions
+Contributions, issues, and feature requests would be awesome, just submit an issue or PR! :)

No alert changes

Improved metrics

Total package byte prevSize

3812

increased by35.03%

Number of lines in readme file

45

increased by1400%

No dependency changes