Skip to content

Commit c819a63

Browse files
authored
Merge pull request #19 from mstachniuk/fix-typos-in-readme
Fix typos in Readme, add codecov badge
2 parents c78bdd3 + 3da17a0 commit c819a63

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
[![Build Status](https://travis-ci.org/mstachniuk/graphql-schema-from-introspection-generator.svg?branch=master)](https://travis-ci.org/mstachniuk/graphql-schema-from-introspection-generator)
55
[![Maven Central](https://img.shields.io/maven-central/v/io.github.mstachniuk/graphql-schema-from-introspection-generator-core.svg)](https://search.maven.org/artifact/io.github.mstachniuk/graphql-schema-from-introspection-generator-core)
66
[![Bintray](https://api.bintray.com/packages/mstachniuk/mstachniuk-maven-repo/maven/images/download.svg) ](https://bintray.com/mstachniuk/mstachniuk-maven-repo/maven/_latestVersion)
7+
[![codecov](https://codecov.io/gh/mstachniuk/graphql-schema-from-introspection-generator/branch/master/graph/badge.svg)](https://codecov.io/gh/mstachniuk/graphql-schema-from-introspection-generator)
78

89
This library helps you generate [GraphQL Schema](https://graphql.org/learn/schema/) (also called [GraphQL DSL or SDL](https://graphql-java.readthedocs.io/en/latest/schema.html)) based on Introspection Query response.
910
It's useful when you use [graphql-java](https://github.com/graphql-java/graphql-java) and [Code First approach](https://graphql-java.readthedocs.io/en/latest/schema.html#creating-a-schema-programmatically) and want to migrate to [Schema First approach](https://graphql-java.readthedocs.io/en/latest/schema.html#creating-a-schema-using-the-sdl).
@@ -13,13 +14,13 @@ It's useful when you use [graphql-java](https://github.com/graphql-java/graphql-
1314
1. Download Command Line Tool from [releases](https://github.com/mstachniuk/graphql-schema-from-introspection-generator/releases) page.
1415
2. Run `java -jar graphql-schema-from-introspection-generator-cli-X.X.X.jar input.json output.graphqls`
1516

16-
File *input.json* should contains output of GrpahQL Introspection query.
17+
File *input.json* should contain the output of GrpahQL Introspection query.
1718
If you don't have this file yet, you can use one from: *core/src/test/resources/testdata/*
1819
3. In *output.graphqls* you will find generated GraphQL Schema.
1920

2021
## How get Introspection Query result?
2122

22-
1. Run you application.
23+
1. Run your application.
2324
2. Run
2425
<details>
2526
<summary>Introspection Query</summary>
@@ -122,7 +123,7 @@ It's useful when you use [graphql-java](https://github.com/graphql-java/graphql-
122123

123124
</details>
124125

125-
3. Store result in file and use Command Line tool for generating schema (See: [How to use it?](#how-to-use-it)).
126+
3. Store result in a file and use Command Line tool for generating the schema (See: [How to use it?](#how-to-use-it)).
126127

127128

128129

@@ -139,10 +140,16 @@ Release notes: [docs/release-notes.md](/docs/release-notes.md)
139140

140141
## Another usage
141142

142-
You can use core library in your projects if you want. Just add a dependency (in Gradle):
143+
You can use the core library in your projects if you want. Just add a dependency (in Gradle):
143144

144145
`compile group: 'io.github.mstachniuk', name: 'graphql-schema-from-introspection-generator-core'`
145146

146147
## How to contribute?
147148

148149
Please Send PR's, issues and feedback via GitHub.
150+
151+
## Alternatives
152+
153+
During finishing this project I found that similar tool already exists in
154+
[graphql-java](https://github.com/graphql-java/graphql-java) project, see `IntrospectionResultToSchema` class.
155+
Unfortunately, I didn't find it before :-(

0 commit comments

Comments
 (0)