Skip to content

Commit bfa05d3

Browse files
authored
docs: make the readme more succinct and quicker to understand
1 parent 8989d99 commit bfa05d3

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

README.md

+9-4
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
1-
# gqlrequests - Create requests to GraphQL APIs with no strings attached 😉
1+
# gqlrequests - Build GraphQL query-strings automagically
22

3+
### ✅ Create queries from pydantic models
4+
### ✅ Create queries from annotated classes
5+
### ✅ Dynamically select query fields
6+
7+
______
38
[![Pytests and Coverage](https://github.com/BeatsuDev/GraphQLRequests/actions/workflows/testing_and_coverage.yml/badge.svg)](https://github.com/BeatsuDev/GraphQLRequests/actions/workflows/testing_and_coverage.yml)
49
[![Code Quality](https://github.com/BeatsuDev/GraphQLRequests/actions/workflows/code_quality.yml/badge.svg)](https://github.com/BeatsuDev/GraphQLRequests/actions/workflows/code_quality.yml)
510
[![codecov](https://codecov.io/gh/BeatsuDev/GraphQLRequests/branch/main/graph/badge.svg?token=FBQKU5OEWT)](https://codecov.io/gh/BeatsuDev/GraphQLRequests)
611

7-
Define GraphQL types in Python as classes or pydantic classes, then use them to automatically build queries. Or even simpler;
8-
gqlrequests will automatically build the classes for you given the api endpoint by using introspection! (Now that's awesome).
9-
You no longer need to define your requests as multiline strings (hence no strings attached).
12+
A dynamic, pythonic way to build queries instead of using large multiline strings.
1013

1114
## Examples of currently working features:
1215

@@ -109,3 +112,5 @@ print(Character)
109112
# }
110113
#
111114
```
115+
116+
### ✅ Query validation while developing in your IDE

0 commit comments

Comments
 (0)