Add NPM readme (#195)

samdenty · Apr 12, 2021 · dd93d75 · dd93d75 · vercel · Apr 12, 2021
1 parent 45f5918
commit dd93d75
Showing 1 changed file with 14 additions and 2 deletions.
diff --git a/packages/gqless/README.md b/packages/gqless/README.md
@@ -1,3 +1,15 @@
-# gqless
+# [GQless](https://gqless.com/introduction/getting-started) [![Documentation](https://img.shields.io/badge/documentation-documentation?color=C00B84)](https://gqless.com) [![Twitter](https://img.shields.io/twitter/follow/gqlessdev?label=%40gqlessdev&style=flat&logo=twitter&color=00acee)](https://twitter.com/gqlessdev)
 
-## Visit [https://gqless.com/core/basic-usage](https://gqless.com/core/basic-usage)
+> GQless is a fully-featured GraphQL client, which lowers the barrier of entry towards using GraphQL.
+
+Data requirements within your application are picked up automatically, freeing you from having to maintain GraphQL queries by-hand. It offers a first-class TypeScript experience. See API documentation at all times within autocomplete.
+
+Make breaking changes to your API, and see type-errors exactly where things are breaking, in realtime. No more running a separate validation step.
+
+
+**More documentation is available at [gqless.com/introduction/getting-started](https://gqless.com/introduction/getting-started).**
+
+
+<a href="https://gqless.com">
+  <img alt="Example usage" src="https://user-images.githubusercontent.com/13242392/112103674-fddc4980-8ba1-11eb-8c83-b527dcb0243d.PNG">
+</a>