graphqlvisualizer - npm Package Compare versions

Comparing version 1.0.4 to 1.0.5

package.json

 {
   "name": "graphqlvisualizer",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "This is a solution that can be used for visualization of an existing graphQL Schema, without the need of having an implemented service, in order to explore the API.",
@@ -5,0 +5,0 @@ "main": "dist/main.js",

README.md

@@ -0,3 +1,44 @@
+Description:
+GraphQlVisualizer is a tool that enables you to visualize existing GraphQL schemas. It lets you explore all aspects of a schema without the need of a functional serverice side. Simply load zour schema froma  local file or from a string and get a generated html page, wich will contain graphical representaion of your scehma in a simple, intuitive and interavctive UI. File will be generated inside src/generated directory, under the name of schemaVisualized.html
+
 Functionalities:
-1. Visualize scheam from file
-2. visualiye schema from string
+1. Visualize schema from local file
+2. visualiye schema from string
+
+Installation:
+Install using NPM 
+npm install --save graphqlvisualizer
+
+Usage:
+Below is an example of how this package could be used
+
+import GraphqlBirdseye from "graphqlvisualizer";
+
+var schemaString = `
+type User{
+    id:ID!
+    firstname:String
+    lastname:String
+    address:Address
+}
+type Address{
+    postalCode:Int
+    city:String
+}
+type Query{
+    """
+    Returns user with specified id
+    """
+    user(id: ID): User
+    """
+    Returns a list of users that have the specified address
+    """
+    usersOnAddress(address: Address): [User]
+}
+type Mutation{
+    createAddress(postalCode:Int!, city:String): Address
+    deleteUser(id:ID):Boolean
+}
+`;
+
+var schema = GenerateHtmlFromString(schemaString);

No alert changes

Improved metrics

Total package byte prevSize

24273

5.35%

Number of lines in readme file

44

1366.67%

No dependency changes