add readme for test helper cli wasm

ashutoshvarma · Mar 18, 2021 · f0b212c · f0b212c
1 parent d19f81b
commit f0b212c
Showing 1 changed file with 25 additions and 0 deletions.
diff --git a/utils/testsuite_helper/README.md b/utils/testsuite_helper/README.md
@@ -0,0 +1,25 @@
+# testsuite_helper
+
+This module is primarily used to expose `JSON.parse` through a CLI environment for testing purpose.
+
+### Return codes :-
+- 0 - If successfully parsed the input
+- 2 - Can't read the file properly
+
+(It needs `wasmtime` to execute) 
+
+## Build
+```
+yarn
+yarn build
+```
+
+## Run
+```
+yarn start --dir FOLDER JSON_FILE_NAME
+```
+or
+```
+wasmtime build/index.wasm --dir FOLDER JSON_FILE_NAME
+```
+