Merge pull request #13 from mpourmpoulis/develop-0.1.0

Develop 0.1.0 - small bits front page and of doc index

Author: mpourmpoulis

README.md

@@ -4,11 +4,11 @@
 
 <!-- ![](https://img.shields.io/static/v1?label=Version&message=0.1.0&color=green) -->
 
-
+[![](https://img.shields.io/badge/documentation-here-green)](https://github.com/mpourmpoulis/PythonVoiceCodingPlugin/blob/master/doc/README.md)
 
 <!-- ![](https://img.shields.io/static/v1?label=Caster&message=0.5.11|0.6.11|1.0.0&color=blue) -->
 
-[![](https://img.shields.io/badge/Caster-0.5.11and0.6.14and1.0.0-blue)](https://github.com/dictation-toolbox/Caster)
+[![](https://img.shields.io/badge/Caster-v0_5_11|v0_6_14|v1_0_0-blue)](https://github.com/dictation-toolbox/Caster)
 
 <!-- ![](https://img.shields.io/static/v1?label=Aenea&message=supported&color=red) -->
 
@@ -26,6 +26,9 @@
 PythonVoiceCodingPlugin is a Sublime Text 3 plugin meant to enhance user experience 
 when coding python 3 by voice. It ships with  an integrated [Caster](https://github.com/dictation-toolbox/Caster)  grammar bundle containing voice commands that provide you with syntactical navigation capabilities!
 
+
+In case you have never heard about voice programming before, you should definitely check out [Caster](https://caster.readthedocs.io/en/latest/), [dragonfly](https://dragonfly2.readthedocs.io/en/latest/introduction.html) and [Talon](https://talonvoice.com/).
+
 ![](doc/gif/big37.gif)
 
 

doc/README.md

@@ -2,7 +2,7 @@
 
 <!-- MarkdownTOC  autolink="true" -->
 
-- [Documentation Index](#documentation-index)
+- [Documentation Index and Command Reference](#documentation-index-and-command-reference)
 - [General Remarks](#general-remarks)
 	- [Caster Version Supported](#caster-version-supported)
 	- [Versioning And Backwards Compatibility](#versioning-and-backwards-compatibility)
@@ -31,21 +31,23 @@
 
 
 
-## Documentation Index
+## Documentation Index and Command Reference
 
 * `WARNING` the following links contain pages heavy in gifs making their size relatively big. If you are on mobile, it might be best to view them via wifi instead of mobile data.
 
 Some quick links to the various documentation files
 
-* [Argument Queries](./SelectArgument.md)
+* [Argument Queries](./SelectArgument.md) that enable you to select an argument or other parts from a function call
 
-* [Big Roi Queries](./SelectBigROI.md)
+* [Big Roi Queries](./SelectBigROI.md) , responsible for selecting "big" regions of interest like an "if condition" (also includes experimental smaller ones)
 
-* [Sub Indexing](./SubIndexing.md)
+* [Sub Indexing](./SubIndexing.md)  Or the art of picking up smaller regions out of bigger ones!
+
+* [Operations](./Operations.md) delete/swap/paste functionality in two formats and some utilities
 
 * [Collection Queries](./CollectionQueries.md)
 
-* [Operations](./Operations.md)
+