Skip to content

Commit

Permalink
Merge pull request #4 from benjie/ide-monorepo-readme
Browse files Browse the repository at this point in the history
Add README to monorepo root
  • Loading branch information
acao authored Jun 9, 2019
2 parents 7e0239e + 9d00ceb commit a9a381b
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# GraphiQL Monorepo

_/ˈɡrafək(ə)l/_ A graphical interactive in-browser GraphQL IDE. [Try the live demo](http://graphql.org/swapi-graphql).

[![Build Status](https://travis-ci.org/graphql/graphiql.svg?branch=master)](https://travis-ci.org/graphql/graphiql)
[![CDNJS](https://img.shields.io/cdnjs/v/graphiql.svg)](https://cdnjs.com/libraries/graphiql)
[![npm](https://img.shields.io/npm/v/graphiql.svg)](https://www.npmjs.com/package/graphiql)

[![](resources/graphiql.png)](http://graphql.org/swapi-graphql)

## Intro

GraphiQL is the reference implementation of a GraphQL IDE, an official
project under the GraphQL Foundation.

This repository contains much of the code that powers GraphiQL, split into
modules that can be used to build custom/alternative editors. The code uses
the permissive MIT license. The main components in this monorepo are:

- [GraphiQL](packages/graphiql/README.md) - the GraphiQL IDE, implemented in React
- [GraphQL mode for CodeMirror](packages/codemirror-graphql/README.md) - provides CodeMirror with a parser mode for GraphQL along with a live linter and typeahead hinter powered by your GraphQL Schema

## Contributing

This is an open source project, and we welcome contributions. Please see
[CONTRIBUTING.md](CONTRIBUTING.md) for details on how to contribute.

0 comments on commit a9a381b

Please sign in to comment.