more readme improvements, fix json whitespace issue causing changeset bug (#29)

Author: acao

.github/workflows/release.yml

@@ -26,7 +26,7 @@ jobs:
         run: yarn
 
       - name: Create Release Pull Request or Publish to npm
-        uses: changesets/action@master
+        uses: changesets/action@v1
         with:
           # this expects you to have a script called release which does a build for your packages and calls changeset publish
           publish: yarn release

README.md

@@ -1,4 +1,8 @@
 # relay-graphql-js
 
-Relay tooling based on graphql-js
+Relay compatible tooling based on `graphql-js`
 
+- [`@relay-graphql-js/graphql-config`](packages/graphql-config/) - a compatibility layer to use relay with `graphql-config` and thus `vscode-graphql` and other tools that use `graphql-config`
+- [`vscode-apollo-relay`](packages/vscode-apollo-relay/) - a relay-enabled compatibility layer for `vscode-apollo` and other tools which use `apollo-config`
+
+These compatibility layers ares all built on `@relay-graphql-js/validation-rules`, the retirement home of the legacy [`graphql-js`](https://github.com/graphql/graphql-js) compatible validation rules

package.json

@@ -20,7 +20,8 @@
     "format": "prettier --write packages/*/{src,tests}/*"
   },
   "devDependencies": {
-    "@changesets/cli": "^2.11.0",
+    "@changesets/cli": "^2.24.1",
+    "@changesets/changelog-github": "^0.4.6",
     "@types/jest": "^26.0.14",
     "@types/node": "^12.7.4",
     "@types/relay-compiler": "^8.0.0",
@@ -36,8 +37,5 @@
     "tslint": "^6.1.3",
     "tslint-plugin-prettier": "^2.3.0",
     "typescript": "^4.0.3"
-  },
-  "dependencies": {
-    "@changesets/changelog-github": "^0.4.6"
   }
 }

packages/graphql-config/README.md

@@ -3,14 +3,15 @@
 [![npm](https://img.shields.io/npm/v/vscode-apollo-relay.svg)](https://www.npmjs.com/package/vscode-apollo-relay)
 [![build](https://img.shields.io/travis/relay-tools/vscode-apollo-relay/master.svg)](https://travis-ci.org/relay-tools/vscode-apollo-relay/builds)
 
-Simple configuration for [`graphql-config`](https://graphql-config.com) compatibility for Relay projects.
+This provides a simple configuration to may relay config to [`graphql-config`](https://graphql-config.com).
 
 Features:
 
-- Read all user configuration from [relay-config], if the project is setup with it.
+- Reads user configuration from [relay-config], if the project is setup with it.
 - Provides definitions for all Relay directives for validation and auto-completion purposes.
 - Provides validation of `@argumentDefinitions` and `@arguments` directives.
 - uses your locally installed `graphql` version!
+- multiple environments are not supported yet but are coming soon!
 
 [Changelog](https://github.com/relay-tools/relay-graphql-js/blob/master/packages/graphql-config/CHANGELOG.md)
 
@@ -43,6 +44,12 @@ const { config } = require("@relay-graphql-js/graphql-config").generateConfig()
 module.exports = config
 ```
 
+
+## Why you might want to use this
+
+Simply for tooling interoperability, if nothing else.
+
+
 ## Limitations
 
 This _does not_ support relay environments => `graphql-config` projects, _yet_. Open a PR if you want it to!

packages/graphql-config/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@relay-graphql-js/graphql-config",
   "version": "0.1.0",
-  "description": "full graphql config for relay graphql",
+  "description": "graphql-config compatibility layer for your relay project",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "homepage": "https://github.com/relay-tools/relay-graphql-js/blob/main/packages/graphql-config#readme",
@@ -17,5 +17,6 @@
   },
   "devDependencies": {
     "graphql-config": "^3.0.3"
-  }
+  },
+  "keywords": ["graphql", "relay", "graphql-config", "vscode-graphql"]
 }

packages/validation-rules/README.md

@@ -0,0 +1,3 @@
+The retirement home of the original `relay-compiler` rules, which are `graphql-js` compatible.
+
+All the libraries in this project use these rules to provide a compatibility layer for relay outside of the relay official tooling.

packages/validation-rules/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@relay-graphql-js/validation-rules",
   "version": "0.1.0",
-  "description": "shared validation rules for graphql-js parser",
+  "description": "shared relay validation rules for graphql-js parser",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "homepage": "https://github.com/relay-tools/relay-graphql-js/blob/main/packages/validation-rules#readme",
@@ -17,5 +17,6 @@
   },
   "peerDependencies": {
     "graphql": ">= 14 < 16"
-  }
+  },
+  "keywords": ["relay", "graphql", "graphql-js", "validation"]
 }

packages/vscode-apollo-relay/README.md

@@ -59,7 +59,7 @@ module.exports = {
 }
 ```
 
-### Compat
+### Compatibility
 
 If you are still using the compatibility mode of Relay you can enable additional validation rules that only apply to Relay compat. `generateConfig` takes a `compat` boolean argument to enable these extra validation rules. Ie:
 

packages/vscode-apollo-relay/package.json

@@ -1,7 +1,7 @@
 {
   "name": "vscode-apollo-relay",
   "version": "1.6.0",
-  "description": "Simple configuration of vscode-apollo for Relay projects.",
+  "description": "Compatibility layer to use relay config with vscode-apollo and other apollo config tools",
   "keywords": [
     "apollo",
     "graphql",