Merge #940

940: Fix prototypes in documentation r=bidoubiwa a=mdubus



Co-authored-by: Morgane Dubus <[email protected]>
Co-authored-by: Morgane Dubus <[email protected]>

Author: bors[bot]

README.md

@@ -328,7 +328,7 @@ If you want to know more about the development workflow or want to contribute, p
 
 - Get an index:
 
-`client.getIndex<T>(uid: string): Index<T>`
+`client.getIndex<T>(uid: string): Promise<Index<T>>`
 
 - Get or create index if it does not exist
 
@@ -340,7 +340,7 @@ If you want to know more about the development workflow or want to contribute, p
 
 - Update Index:
 
-`client.updateIndex(uid): Promise<Index>`
+`client.updateIndex(uid: string, options: IndexOptions): Promise<Index>`
 Or using the index object:
 `index.update(data: IndexOptions): Promise<Index>`