Documentation added

DOC/EN/README.html

@@ -0,0 +1,21 @@
+<h1 id="worddefinition">wordDefinition</h1>
+<p>A NVDA addon for get definitions from a selected word.</p>
+<h2 id="information">Information</h2>
+<ul>
+<li>Author: Ernesto Blanco, <a href="mailto:mail@ernestoblanco.mx" class="email">mail@ernestoblanco.mx</a></li>
+</ul>
+<h2 id="requirements">Requirements</h2>
+<ul>
+<li>NVDA 2017.2 to 2019.2.1. It works with Python 2.7! When NVDA 2019.3 will released, it will be updated to Python 3.</li>
+</ul>
+<h2 id="installation">Installation</h2>
+<ul>
+<li>Download <a href="https://github.com/bcernesto/wordDefinition/raw/master/wordDefinition.nvda-addon">stable version</a></li>
+<li>Open the downloaded file with NVDA running, and answer “Yes” to dialogs of the installation process.</li>
+</ul>
+<h2 id="usage">Usage</h2>
+<ul>
+<li>Select any word and press Ctrl+Shift+F11 for show a NVDA browseable dialog with the definitions of the selected word.</li>
+<li>It works with https://googledictionaryapi.eu-gb.mybluemix.net/ api</li>
+<li>This command can be modified in the “Input gestures” dialog in the “Text editing” section.</li>
+</ul>

DOC/EN/README.md

@@ -0,0 +1,23 @@
+# wordDefinition
+A NVDA addon for get definitions from a selected word.
+
+## Information
+
+* Author: Ernesto Blanco, <mail@ernestoblanco.mx>
+
+## Requirements
+
+* NVDA 2017.2 to 2019.2.1. It works with Python 2.7! When NVDA 2019.3 will released, it will be updated to Python 3.
+
+## Installation
+
+* Download [stable version][1]
+* Open the downloaded file with NVDA running, and answer "Yes" to dialogs of the installation process.
+
+## Usage
+
+* Select any word and press Ctrl+Shift+F11 for show a NVDA browseable dialog with the definitions of the selected word.
+* It works with https://googledictionaryapi.eu-gb.mybluemix.net/ api
+* This command can be modified in the "Input gestures" dialog in the "Text editing" section.
+
+[1]:https://github.com/bcernesto/wordDefinition/raw/master/wordDefinition.nvda-addon

DOC/ES/README.html

@@ -0,0 +1,21 @@
+<h1 id="worddefinition">wordDefinition</h1>
+<p>Un addon para NVDA que proporciona definiciones de una palabra seleccionada.</p>
+<h2 id="información">Información</h2>
+<ul>
+<li>Autor: Ernesto Blanco, <a href="mailto:mail@ernestoblanco.mx" class="email">mail@ernestoblanco.mx</a></li>
+</ul>
+<h2 id="requerimientos">Requerimientos</h2>
+<ul>
+<li>NVDA 2017.2 a 2019.2.1. Funciona con Python 2.7! -cuando NVDA 2019.3 sea liberado, Lo actualizaré a Python 3.</li>
+</ul>
+<h2 id="instalación">Instalación</h2>
+<ul>
+<li>Descarga la <a href="https://github.com/bcernesto/wordDefinition/raw/master/wordDefinition.nvda-addon">versión estable</a></li>
+<li>Abre el archivo descargado con NVDA ejecutándose, y responde “Sí” a los diálogos del proceso de instalación.</li>
+</ul>
+<h2 id="uso">Uso</h2>
+<ul>
+<li>Selecciona una palabra y presiona Ctrl+Shift+F11 para mostrar un diálogo navegable de NVDA con las definiciones de la palabra seleccionada.</li>
+<li>Este complemento hace uso del servicio de https://googledictionaryapi.eu-gb.mybluemix.net/</li>
+<li>El método abreviado puede modificarse en el diálogo “Gestos de entrada” en la sección “Edición de texto”</li>
+</ul>

DOC/ES/README.md

@@ -0,0 +1,23 @@
+# wordDefinition
+Un addon para NVDA  que proporciona definiciones de una palabra seleccionada.
+
+## Información
+
+* Autor: Ernesto Blanco, <mail@ernestoblanco.mx>
+
+## Requerimientos
+
+* NVDA 2017.2 a 2019.2.1. Funciona con Python 2.7! -cuando NVDA 2019.3 sea liberado, Lo actualizaré a Python 3.
+
+## Instalación
+
+* Descarga la [versión estable][1]
+* Abre el archivo descargado con NVDA ejecutándose, y responde "Sí" a los diálogos del proceso de instalación.
+
+## Uso
+
+* Selecciona una palabra y presiona Ctrl+Shift+F11 para mostrar un diálogo navegable de NVDA con las definiciones de la palabra seleccionada.
+* Este complemento hace uso del servicio de https://googledictionaryapi.eu-gb.mybluemix.net/
+* El método abreviado puede modificarse en el diálogo "Gestos de entrada" en la sección "Edición de texto"
+
+[1]:https://github.com/bcernesto/wordDefinition/raw/master/wordDefinition.nvda-addon

manifest.ini

@@ -3,6 +3,7 @@ summary = Define any selected word"
 description = "Show a browseable dialog with definitions when you select some word and press Control+Shift+F11."
 author = "Ernesto Blanco <mail@ernestoblanco.mx>"
 url = https://github.com/bc_ernesto/wordDefinition
+docFileName = README.html
 version = 1.0
 minimumNVDAVersion = 2017.2.0
 lastTestedNVDAVersion = 2019.2.1