Combine docs into readme and remove vuepress

Author: CodingItWrong

README.md

@@ -59,7 +59,116 @@ client.all().then(results => console.log(results));
 
 ## Usage
 
-For more information on usage, see the [`@reststate/client` docs](https://client.reststate.codingitwrong.com).
+### Reading Data
+
+#### all
+
+To retrieve all of the records for a resource, call the `all()` method. The method returns a promise that will resolve to the server's JSON response:
+
+```javascript
+resource.all().then(response => console.log(response.data));
+```
+
+#### find
+
+To retrieve a single record by ID, call the `find()` method:
+
+```javascript
+resource.find({ id: 42 }).then(response => console.log(response.data));
+```
+
+#### where
+
+To filter/query for records based on certain criteria, use the `where` method, passing it an object of filter keys and values to send to the server:
+
+```javascript
+const filter = {
+  category: 'whizbang',
+};
+resource.where({ filter }).then(response => console.log(response.data));
+```
+
+#### related
+
+Finally, to load records related via JSON:API relationships, use the `related` method. A nested resource URL is constructed like `categories/27/widgets`. (In the future we will look into using HATEOAS to let the server tell us the relationship URL).
+
+```javascript
+const parent = {
+  type: 'category',
+  id: 27,
+};
+
+resource.related({ parent }).then(response => console.log(response.data));
+```
+
+By default, the name of the relationship on `parent` is assumed to be the same as the name of the other model: in this case, `widgets`. In cases where the names are not the same, you can explicitly pass the relationship name:
+
+```javascript
+const parent = {
+  type: 'categories',
+  id: 27,
+};
+
+const relationship = 'purchased-widgets';
+
+resource
+  .related({ parent, relationship })
+  .then(response => console.log(response.data));
+```
+
+#### Options
+
+All read methods take an optional `options` property, consisting of an object of additional options to pass. Each key/value pair in the object is translated into a query string parameter key/value pair:
+
+```js
+resource.all({
+  options: {
+    include: 'comments',
+  },
+});
+
+// requests to widgets?include=comments
+```
+
+### Writing
+
+#### create
+
+Creates a new record. The object passed in should follow the JSON:API object format, but the `type` can be omitted:
+
+```js
+widgetResource.create({
+  attributes: {
+    'name': 'My Widget',
+    'creation-date': '2018-10-07',
+  },
+});
+```
+
+This isn't just limited to `attributes`; `relationships` can be passed in too.
+
+#### update
+
+Updates a record. Takes the `id` of the record and the `attributes` and/or `relationships` to update. No `type` argument is required, but if passed in it's ignored, so you can pass in a full record if you like.
+
+```js
+widgetResource.update({
+  id: '42',
+  attributes: {
+    name: 'My Updated Widget',
+  },
+});
+```
+
+This isn't just limited to `attributes`; `relationships` can be passed in too.
+
+#### delete
+
+Deletes the passed-in record. Only the `id` property is used, so you can pass either a full record or just the ID:
+
+```js
+widgetResource.delete({ id: 42 });
+```
 
 ## License
 

docs/.vuepress/config.js

@@ -8,14 +8,11 @@
   "license": "Apache-2.0",
   "scripts": {
     "test": "jest --watchAll",
-    "lint": "eslint \"{src,test}/*.js\"",
-    "docs:dev": "vuepress dev docs",
-    "docs:build": "vuepress build docs"
+    "lint": "eslint \"{src,test}/*.js\""
   },
   "devDependencies": {
     "@babel/core": "^7.1.2",
     "@babel/preset-env": "^7.1.0",
-    "@vuepress/plugin-google-analytics": "^1.0.1",
     "acorn": "^8.0.1",
     "babel-core": "^7.0.0-0",
     "babel-eslint": "^10.0.1",
@@ -28,7 +25,6 @@
     "kind-of": "^6.0.3",
     "prettier": "2.1.2",
     "serialize-javascript": "^5.0.1",
-    "set-value": "^4.0.1",
-    "vuepress": "^1.0.1"
+    "set-value": "^4.0.1"
   }
 }