Correcciones de documentacion y pruebas de funcionamiento
This commit is contained in:
55
README.md
Normal file
55
README.md
Normal file
@@ -0,0 +1,55 @@
|
||||
# Word Clock Javascript
|
||||
|
||||
Este ejercicio didactico busca aprender a crear un modulo para nodejs y a utilizar la documentacion generada por JSDocs y los test Mocha.
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Tabla de Contenidos
|
||||
- 🚀 Descripción
|
||||
- ✨ Características
|
||||
- ⚙️ Instalación
|
||||
- 💡 Uso
|
||||
- 🔧 Tecnologías
|
||||
- 📄 Licencia
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Descripción
|
||||
Este coodigo pretende explicar como funcionan los modulos para nodejs y la implementacion de test de Mocha.
|
||||
|
||||
|
||||
## ✨ Características
|
||||
* Ejecucion en el terminal de NodeJS
|
||||
* Cambio entre tres idiomas
|
||||
* Documentacion mediante JSDocs
|
||||
* Test mediante Mocha
|
||||
|
||||
## ⚙️ Instalación
|
||||
1. Clona el repositorio:
|
||||
```bash
|
||||
git clone https://git.interlan.ec/Drk0027/Word-Clock-Javascript.git
|
||||
```
|
||||
2. Navega al directorio:
|
||||
```bash
|
||||
cd Word-Clock-Javascript
|
||||
```
|
||||
3. Instala las dependencias:
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
|
||||
## 💡 Uso
|
||||
**Ejemplo Básico:**
|
||||
```bash
|
||||
npm run run #Ejecuta en idioma inglés
|
||||
npm run run_eo #Ejecuta en idioma esperanto
|
||||
npm run run_es #Ejecuta en idioma español
|
||||
npm run test #Ejecuta test mocha
|
||||
```
|
||||
|
||||
# 🔧 Tecnologías Usadas
|
||||
|
||||
Lenguaje: JavaScript (Node.js)
|
||||
|
||||
# 📄 Licencia
|
||||
Este proyecto está bajo la licencia MIT.
|
||||
Reference in New Issue
Block a user