readme: document interfaces, scaffold command separately

prisma-labs · Aug 16, 2018 · b2adafd · b2adafd
1 parent c5ff441
commit b2adafd
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -28,6 +28,15 @@ Options:
   Possible commands: scaffold, interfaces
 ```
 
+### Commands
+
+| Command    | Description                                                                                   | Flag -s              | Flag -o                                 | Flag -g    | Flag -i                               | Flag -f                                                                  |
+| ---------- | --------------------------------------------------------------------------------------------- | -------------------- | --------------------------------------- | ---------- | ------------------------------------- | ------------------------------------------------------------------------ |
+| interfaces | Generate type safe interfaces for resolves based on your schema.                              | Path to input schema | Path to generate interfaces file at     | typescript | NA                                    | NA                                                                       |
+| scaffold   | Scaffold resolvers based on your schema that rely on the generated interface for type safety. | Path to input schema | Path to folder for generating resolvers | typescript | Path to the generated interfaces file | Force write resolver files when there is a collision with existing files |
+
+Note: while using `scaffold`, types.ts will always be generated irrespective of `-f` flag.
+
 ### Example
 
 ##### To generate both resolvers and typings for a given GraphQL schema, run the following commands