Skip to content

Commit 0b1dfe8

Browse files
committed
Add some badges
1 parent c4d7738 commit 0b1dfe8

1 file changed

Lines changed: 27 additions & 0 deletions

File tree

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Golang GraphiQL
2+
[![GitHub version](https://badge.fury.io/gh/friendsofgo%2Fgraphiql.svg)](https://badge.fury.io/gh/friendsofgo%2Fgraphiql)
23
[![Build Status](https://travis-ci.org/friendsofgo/graphiql.svg?branch=master)](https://travis-ci.org/friendsofgo/graphiql)
4+
[![Go Report Card](https://goreportcard.com/badge/github.com/friendsofgo/graphiql)](https://goreportcard.com/report/github.com/friendsofgo/graphiql)
5+
[![CDNJS](https://img.shields.io/cdnjs/v/graphiql.svg)](https://cdnjs.com/libraries/graphiql)
36
[![GoDoc](https://godoc.org/graphql.co/graphql?status.svg)](https://godoc.org/github.com/friendsofgo/graphiql)
47

58
An utility wrote on Go for using GraphiQL without need to use NPM.
@@ -66,9 +69,33 @@ func main() {
6669
http.Handle("/graphiql", graphiqlHandler)
6770
http.ListenAndServe(":4040", nil)
6871
}
72+
```
6973

7074
## CLI
75+
Yo can use `graphiql` as command
76+
```bash
77+
$ graphiql --help
78+
usage: graphiql [-version] [OPTIONS]
79+
graphiql is an standalone server to use Graphiql, based on https://github.com/graphql/graphiql
80+
81+
-endpoint string
82+
Endpoint where are hosted your API, eg: http://localhost:8080/graphql (default "http://localhost:8080/graphql")
83+
-graphiql
84+
Show the js client of GraphiQL version
85+
-port string
86+
Port where will be launched the GraphiQL client (default "4040")
87+
-version
88+
Show the graphiql version information
89+
```
7190

91+
And it'll launch a `GraphiQL` server
92+
```bash
93+
$ graphiql
94+
95+
2018/11/24 17:10:36 GraphiQL run on http://localhost:4040...
96+
2018/11/24 17:10:36 GraphQL endpoint http://localhost:8080/graphql
97+
2018/11/24 17:10:36 Use (ctrl+c) for terminate the execution
98+
```
7299

73100
## Contribute
74101
[Contributions](https://github.com/friendsofgo/graphiql/issues?q=is%3Aissue+is%3Aopen) are more than welcome, if you are interested please fork this repo and send your Pull Request.

0 commit comments

Comments
 (0)