Skip to content

Commit f88a388

Browse files
committed
Cleanup README with better summary
1 parent de113cf commit f88a388

File tree

3 files changed

+12
-8
lines changed

3 files changed

+12
-8
lines changed

Gemfile.lock

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
PATH
22
remote: .
33
specs:
4-
graphql-sources (1.5.2)
4+
graphql-sources (1.5.3)
55
graphql
66
rails
77
zeitwerk

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
# GraphQL::Sources
22

3+
[![LICENSE](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/ksylvest/graphql-sources/blob/main/LICENSE)
4+
[![RubyGems](https://img.shields.io/gem/v/graphql-sources)](https://rubygems.org/gems/graphql-sources)
5+
[![GitHub](https://img.shields.io/badge/github-repo-blue.svg)](https://github.com/ksylvest/graphql-sources)
6+
[![Yard](https://img.shields.io/badge/docs-site-blue.svg)](https://graphql-sources.ksylvest.com)
7+
[![CircleCI](https://img.shields.io/circleci/build/github/ksylvest/graphql-sources)](https://circleci.com/gh/ksylvest/graphql-sources)
8+
[![Maintainability](https://api.codeclimate.com/v1/badges/bc301cb72712637e67dd/maintainability)](https://codeclimate.com/github/ksylvest/graphql-sources/maintainability)
9+
[![Test Coverage](https://api.codeclimate.com/v1/badges/bc301cb72712637e67dd/test_coverage)](https://codeclimate.com/github/ksylvest/graphql-sources/test_coverage)
10+
11+
`GraphQL::Sources` is a set of predefined dataloader classes build to avoid common n-plus-one issues in a GraphQL schema with Ruby. It supports loading `has_one`, `has_many`, `belongs_to`, `has_and_belongs_to_many`, `has_one_attached` and `has_many_attached` associations.
12+
313
## Installation
414

515
Install the gem and add to the application's Gemfile by executing:
@@ -321,12 +331,6 @@ class UserType < GraphQL::Schema::Object
321331
end
322332
```
323333

324-
## Status
325-
326-
[![CircleCI](https://circleci.com/gh/ksylvest/graphql-sources.svg?style=svg)](https://circleci.com/gh/ksylvest/graphql-sources)
327-
[![Maintainability](https://api.codeclimate.com/v1/badges/bc301cb72712637e67dd/maintainability)](https://codeclimate.com/github/ksylvest/graphql-sources/maintainability)
328-
[![Test Coverage](https://api.codeclimate.com/v1/badges/bc301cb72712637e67dd/test_coverage)](https://codeclimate.com/github/ksylvest/graphql-sources/test_coverage)
329-
330334
## License
331335

332336
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

lib/graphql/sources/version.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22

33
module GraphQL
44
module Sources
5-
VERSION = '1.5.2'
5+
VERSION = '1.5.3'
66
end
77
end

0 commit comments

Comments
 (0)