docs: updated the README for the new input format

tannerntannern · Jun 3, 2019 · e95a5fe · e95a5fe
1 parent 8b95bbd
commit e95a5fe
Showing 1 changed file with 10 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -35,8 +35,16 @@ import {makeAdapter} from 'adapter';
 
 type Resolve = AxiosResponse;
 type Input = {
-    'text': { key: 'access-token' | 'repo-name', message: string, return: string },
-    'yes-no': { key: 'private' | 'retry', message: string, return: boolean }
+    types: { 'text': string, 'yes-no': boolean },
+    options: {
+        [type: string]: { message: string }
+    },
+    keys: {
+        'access-token': 'text',
+        'repo-name': 'text',
+        'private': 'yes-no',
+        'retry': 'yes-no',
+    }
 };
 type Output = string;