Update readme

Author: CITGuru

README.md

@@ -4,7 +4,7 @@ A Python module for handling config files. It helps handles persist config files
 
 > Easily load and persist config without having to think about where and how
 
-It's built base on nodejs [configstore](https://github.com/yeoman/configstore)
+It's built base on nodejs [configstore](https:#github.com/yeoman/configstore)
 
 Config is stored in a JSON file located in `$XDG_CONFIG_HOME` or `~/.localconfig`.<br>
 Example: `~/.localconfig/configstore/name.json`
@@ -20,49 +20,51 @@ pip install pyconfig
 ```python
 from pyconfig import ConfigStore
 
-// create a Configstore instance with a unique name e.g. gnit
-// Package name and optionally some default values
+# create a Configstore instance with a unique name e.g. gnit
+# Package name and optionally some default values
 conf = ConfigStore("Gnit", {"foo": 'bar'});
 
 print(conf.get('foo'));
-//>>> 'bar'
+#>>> 'bar'
 
 conf.set('awesome', True);
 print(conf.get('awesome'));
-//>>> True
+#>>> True
 
-// Use dot-notation to set nested properties
+# Use dot-notation to set nested properties
 conf.set('bar.baz', True);
 print(conf.get('bar'));
-//>>> {"baz": True}
+#>>> {"baz": True}
+
+# escape dot-notation to set nested properties
+conf.set('bar.baz\\.bag', True);
+print(conf.get('bar'));
+#>>> {"baz.bag": True}
 
 conf.delete('awesome');
 print(conf.get('awesome'));
-//>>>
+#>>>
 ```
 
-
 ## API
 
-### Configstore(packageName, [defaults], [options])
+### Configstore(packageName, [defaults], globalConfigPath)
 
 Returns a new instance.
 
 #### packageName
 
-Type: `string`
+Type: `str`
 
 Name of your package.
 
 #### defaults
 
-Type: `Object`
+Type: `dicts`
 
 Default config.
 
-#### options
-
-##### globalConfigPath
+#### globalConfigPath
 
 Type: `bool`<br>
 Default: `False`
@@ -97,9 +99,9 @@ Delete an item.
 
 Delete all items.
 
-### .all
+### .all()
 
-Get all the config as an object or replace the current config with an object:
+Get all the config as a dict or replace the current config with an object:
 
 ```python
 conf.all({
@@ -115,8 +117,23 @@ Get the item count.
 
 Get the path to the config file. Can be used to show the user where the config file is located or even better open it for them.
 
+## Contribute
+
+Yes, you can contribute. Just dm on <twitter:[@OyetokeT](http://twitter.com/@OyetokeT)>
+
+## TODO
+
+There are couple of things I still need to add
+
+1. Dot-notation: Currently, you can only set configs using this feature. (get, delete)
+
+2. Stream: I planned to add a param that'll indicate that you want it to hit the file for every operation. Well that's how it works currently though. But to make it smarter, we don't need to hit the file for (size, get, has, all) operation. We are going to call the `.all()` to get the configs and do the operation just using dict properties.
+
+and more...
 
 ## License
 Copyright - 2018
-Oyetoke Toby <twitter:@OyetokeT>
+
+Oyetoke Toby <twitter:[@OyetokeT](http://twitter.com/@OyetokeT)>
+
 MIT LICENSE