Skip to content

Commit 1093b86

Browse files
committed
readme updates
1 parent 9646dfb commit 1093b86

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

README.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,12 @@
99

1010
## Features
1111
### **Core Features**
12-
1. Starts your GraphQL server (if it is not already running). NOTE: GraphQuill is now compatible with servers running in docker containers. It will check the specified port to see if it is already running.
12+
1. Starts your GraphQL server (if it is not already running).
13+
14+
NOTE: GraphQuill is compatible with local and dockerized servers and will check if the specified port has a running server on it.
15+
GraphQuill is also compatible with **external** API's (accessed via a url in the config file).
1316
2. Parses GraphQL queries/mutations that are typed into the current open document in VS Code.
14-
3. Sends the queries/mutations to your GraphQL API.
17+
3. Sends the queries/mutations to the GraphQL API.
1518
4. Renders the responses to the GraphQuill output channel on VS Code.
1619

1720
<img width="800px" src="./DOCUMENTATION/gifs/basicDemo.gif" alt="demo gif" />
@@ -30,7 +33,7 @@ ___
3033
GraphQuill can be installed from the VS Code Extensions marketplace [here](https://marketplace.visualstudio.com/items?itemName=sproutdeveloping.graphquill).
3134

3235
### **Setting up the config file**
33-
Open the command palette in VS Code (Cmd/Ctrl + Shift + P) and select `"GraphQuill: Create GraphQuill Config File"`. A default config file will be generated. If you're using a locally-hosted server, update the entry point with your server's file path and add a port number. If you're using an external server, set the entrypoint to its URL. For more details, refer to the [documentation](./DOCUMENTATION/docs/documentation.md).
36+
Open the command palette in VS Code (Cmd/Ctrl + Shift + P) and select `"GraphQuill: Create GraphQuill Config File"`. A default config file will be generated. If you're using a **locally-hosted server**, update the entry point with your server's file path and add a port number. If you're using an **external server**, set the entrypoint to its URL. For more details, refer to the [documentation](./DOCUMENTATION/docs/documentation.md).
3437

3538
### GraphQuill's Mock GraphQL API
3639
A GraphQL API that was used during GraphQuill's development has been open sourced in two repositories on Github to allow users to give GraphQuill a test drive. Below are two repositories, one that has been dockerized, and one that uses locally hosted PostgreSQL and MongoDB databases.
@@ -64,4 +67,4 @@ We are always looking to improve. If there are any contributions, feature reques
6467
## Release Notes
6568
Created by: Alex Chao, Austin Ruby and Edward Greenberg
6669

67-
0.15.0 | Initial release of GraphQuill, More to come!
70+
0.16.0 | Initial release of GraphQuill, More to come!

0 commit comments

Comments
 (0)