Merge pull request #2 from ZEXSM/feature/docs

add docs

Author: ZEXSM

README.md

@@ -1 +1,41 @@
-# GraphQL.Tool.Embedded
+# GraphQL.Tool.Embedded
+Library of GraphQL tools such as GraphQL Playground and GraphQL Voyager.
+
+[![Build Status](https://travis-ci.com/ZEXSM/GraphQL.Tool.Embedded.svg?branch=main)](https://travis-ci.com/ZEXSM/GraphQL.Tool.Embedded)
+[![Nuget Status](https://img.shields.io/nuget/dt/GraphQL.Tool.Embedded.svg)](https://www.nuget.org/packages/GraphQL.Tool.Embedded)
+
+## Usage
+
+Default use
+
+```csharp
+app.UseEndpoints(endpoints =>
+{
+    ...
+    endpoints.MapGraphQLPlayground();
+    endpoints.MapGraphQLVoyager();
+});
+```
+
+Using with settings
+
+```csharp
+app.UseEndpoints(endpoints =>
+{
+    ...
+    // https://github.com/graphql/graphql-playground#settings
+    var playgroundOptions = PlaygroundOptions
+    {
+        ...
+    }
+
+    // https://github.com/APIs-guru/graphql-voyager#properties
+    var voyagerOptions = VoyagerOptions
+    {
+        ...
+    }
+
+    endpoints.MapGraphQLPlayground("/ui/playground", playgroundOptions);
+    endpoints.MapGraphQLVoyager("/ui/voyager", VoyagerOptions);
+});
+```

src/GraphQL.Tool.Embedded/GraphQL.Tool.Embedded.csproj

@@ -12,7 +12,7 @@
     <PackageProjectUrl>https://github.com/ZEXSM/GraphQL.Tool.Embedded</PackageProjectUrl>
     <RepositoryUrl>https://github.com/ZEXSM/GraphQL.Tool.Embedded</RepositoryUrl>
     <RepositoryType>git</RepositoryType>
-    <PackageTags>graphql;graphql-playground;graphql-voyager</PackageTags>
+    <PackageTags>graphql;graphql-playground;graphql-voyager;graphql-tools;graphql-dotnet</PackageTags>
     <Authors>ZEXSM</Authors>
     <Description>Library of GraphQL tools such as GraphQL Playground and GraphQL Voyager.</Description>
   </PropertyGroup>

src/GraphQL.Tool.Embedded/Voyager/VoyagerOptions.cs

@@ -12,6 +12,8 @@ public VoyagerOptions()
                 ["Accept"] = MediaTypeNames.Application.Json,
                 ["Content-Type"] = MediaTypeNames.Application.Json,
             };
+
+            // TODO implement https://github.com/APIs-guru/graphql-voyager#properties
         }
     }
 }