Add documentation and better description

Author: ayan-b

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 - Pedantic style checking
 - Detailed instructions in README
+- Add documentations
 
 ## 0.0.1
 

lib/src/traverser.dart

@@ -1,17 +1,26 @@
 import 'dart:convert';
 
+/// ElementNotFound Exception implementation, currently simply prints the
+/// error message
 class ElementNotFoundException implements Exception {
   ElementNotFoundException(String errorString) {
     print(errorString);
   }
 }
 
+/// JSONTraverse class, implements the query method as well
 class JSONTraverse {
   Map<String, dynamic> decodedJSON;
+
+  /// The constructor converts the `jsonString` to `Map<String, dynamic>`
+  /// which is used by the `query` method.
   JSONTraverse(jsonString) {
     decodedJSON = jsonDecode(jsonString);
   }
 
+  /// The query method takes `queryString` and then splits into an array of
+  /// strings. The converted map(that is, `decodedJSON`) is then traversed using 
+  /// the splitted strings, reducing it at every step.
   dynamic query(String queryString) {
     var splittedString = queryString.split('.');
     dynamic reduced = decodedJSON;

pubspec.yaml

@@ -1,7 +1,7 @@
 name: json_traverse
 version: 0.0.2
 
-description: Parse deeply nested JSON using simple query strings.
+description: Parse deeply nested JSON using simple query strings with dot separator.
 homepage: https://github.com/ayan-b/json_traverse
 
 environment: