Update README.md

Author: mheap

README.md

@@ -10,11 +10,11 @@ npm install octokit-commit-multiple-files --save
 
 ## Usage
 
-This plugin accepts `owner`, `repo`, `path`, `branch` and `message` like `.createOrUpdateFile` ([Octokit Docs](https://octokit.github.io/rest.js/#octokit-routes-repos-create-or-update-file)).
+This plugin accepts `owner`, `repo`, `path` and `branch` like `.createOrUpdateFile` ([Octokit Docs](https://octokit.github.io/rest.js/#octokit-routes-repos-create-or-update-file)).
 
 If the `branch` provided does not exist, the plugin will error. To automatically create it, set `createBranch` to true. You may provide a `base` branch if you choose to do this, or the plugin will use the repo's default branch as the base.
 
-In addition, it accepts `changes` which is an array of objects containing a `path` and the file `contents`.
+In addition, it accepts `changes` which is an array of objects containing a `message` and a `files` object
 
 ```javascript
 const Octokit = require("@octokit/rest").plugin(
@@ -27,17 +27,39 @@ const branchName = await octokit.repos.createOrUpdateFiles({
   repo,
   branch,
   createBranch,
-  message,
   changes: [
     {
-      path: "test.md",
-      contents: "One"
+      message: "Your commit message",
+      files: {
+        "test.md": `# This is a test
+
+I hope it works`,
+        "test2.md": {
+          contents: `Something else`
+        }
+      }
     },
     {
-      path: "test2.md",
-      contents: "Two"
+      "message": "This is a separate commit",
+      "files": {
+        "second.md": "Where should we go today?"
+      }
     }
   ]
 })
 ```
 
+In addition, you can set the `mode` of a file change. For example, if you wanted to update a submodule pointer:
+
+```javascript
+{
+  "message": "This is a submodule commit",
+  "files": {
+    "my_submodule": {
+      "contents": "your-commit-sha",
+      "mode": "160000",
+      "type": "commit"
+    }
+  }
+}
+```