Skip to content

Commit

Permalink
Updated README.md with info on pre-built platform-specific downloads
Browse files Browse the repository at this point in the history
  • Loading branch information
faazshift committed Mar 5, 2017
1 parent 535fdd0 commit 6b601dc
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,15 @@
[![Build Status](https://travis-ci.org/faazshift/graphiql-ui.svg?branch=master)](https://travis-ci.org/faazshift/graphiql-ui)
[![Build status](https://ci.appveyor.com/api/projects/status/j4tqlfkg9i9r43pw?svg=true)](https://ci.appveyor.com/project/faazshift/graphiql-ui)

A minimal, electron-based, desktop user interface for the GraphiQL IDE
A minimal, electron-based desktop user interface for the GraphiQL IDE

# Quick Start Guide
# Downloads

For 64-bit Windows and Linux, there are prebuilt packages attached to the releases on Github. See [this](https://github.com/faazshift/graphiql-ui/releases) page. Download the appropriate release for your platform, extract it where you'd like, optionally create a symlink/shortcut to the executable, and enjoy.

Currently there are no installers. You will have to install the package manually. However, it's pretty quick and simple to do so:
For other platforms, use the guide below to get started.

# Quick Start Guide

1. Download the code:
* GitHub: `$ git clone https://github.com/faazshift/graphiql-ui.git && cd graphiql-ui`
Expand All @@ -19,4 +23,4 @@ Currently there are no installers. You will have to install the package manually
4. Create a symlink:
* `$ ln -s /opt/graphiql-ui/graphiql-ui /usr/local/bin/graphiql-ui`

This app was developed on Linux, and has only been tested on that platform. However, it should build and run on OS X and Windows.
This app was developed on Linux. However, it should build and run on OS X and Windows.

0 comments on commit 6b601dc

Please sign in to comment.