docs: update api

tuananh · Apr 24, 2020 · f8e394f · f8e394f
1 parent c6538b6
commit f8e394f
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/API.md b/API.md
@@ -7,6 +7,10 @@
 
 ## camaro
 
+### `ready()`
+
+Initialize module. Needed to be called once before calling other methods.
+
 ### `transform(xml, template)`
 
 Transform xml string to JSON using the given template powered by XPath where:
@@ -44,6 +48,8 @@ const template = {
 
 ### `toJson(xml)`
 
+**Not yet implemented**
+
 Transform xml string to JSON where:
 - `xml` - the input xml string