feat: documentation

CONTRIBUTING.MD

@@ -0,0 +1,86 @@
+# Contribución
+
+Cuando contribuya a este repositorio, por favor, primero discuta el cambio que desea hacer a través de issue,
+correo electrónico, o cualquier otro método con los propietarios de este repositorio antes de hacer un cambio. 
+
+Tenga en cuenta que tenemos un código de conducta, por favor, sígalo en todas sus interacciones con el proyecto.
+
+## Proceso de Pull Request 
+
+1. Asegúrese de que todas las dependencias de instalación o compilación se eliminan antes del final de la capa al realizar una 
+   compilación.
+2. Actualizar el archivo README.md con los detalles de los cambios en la interfaz. 
+   variables de entorno, puertos expuestos, ubicaciones de archivos útiles y parámetros del contenedor.
+3. Aumentar los números de versión en cualquier archivo de ejemplo y en el README.md a la nueva versión que este
+   Pull Request. El esquema de versiones que utilizamos es [SemVer](http://semver.org/).
+4. Puede fusionar la Pull Request una vez que tenga el visto bueno de otros dos desarrolladores y el creador del código. 
+
+   no tiene permiso para hacerlo, puede solicitar al segundo revisor que lo fusione por usted.
+
+## Codigo de Conducta
+
+### Nuestro compromiso
+
+En el interés de fomentar un ambiente abierto y acogedor, nosotros como
+contribuidores y mantenedores nos comprometemos a hacer de la participación en nuestro proyecto y
+comunidad sea una experiencia libre de acoso para todo el mundo, independientemente
+discapacidad, origen étnico, identidad y expresión de género, nivel de experiencia,
+nacionalidad, apariencia personal, raza, religión o identidad y orientación sexual.
+sexual.
+
+### Nuestros Estandares
+
+Ejemplos de comportamientos que contribuyen a crear un entorno positivo
+incluyen:
+
+* Utilizar un lenguaje acogedor e integrador
+* Respetar los distintos puntos de vista y experiencias.
+* Aceptar con gracia las críticas constructivas
+* Centrarse en lo que es mejor para la comunidad
+* Mostrar empatía hacia otros miembros de la comunidad
+
+Ejemplos de comportamiento inaceptable por parte de los participantes son:
+
+* El uso de lenguaje o imágenes sexualizados y la atención o insinuaciones sexuales no deseadas.
+atención o insinuaciones sexuales no deseadas
+* Trolling, comentarios insultantes o despectivos y ataques personales o políticos.
+* Acoso público o privado
+* Publicar información privada de otros, como una dirección física o
+  publicar información privada de otros, como una dirección física o electrónica, sin permiso explícito
+* Otras conductas que puedan considerarse razonablemente inapropiadas en un entorno profesional.
+  profesional
+
+### Nuestras responsabilidades
+
+Los responsables del mantenimiento del proyecto son responsables de aclarar las normas de comportamiento aceptable y deben tomar las medidas correctivas adecuadas y justas en caso de incumplimiento.
+comportamiento aceptable y se espera que tomen medidas correctivas apropiadas y justas en
+respuesta a cualquier caso de comportamiento inaceptable.
+
+Los mantenedores del proyecto tienen el derecho y la responsabilidad de eliminar, editar o
+o rechazar comentarios, confirmaciones, código, ediciones wiki, problemas y otras contribuciones
+que no se ajusten a este Código de Conducta, o de prohibir temporal o permanentemente
+permanentemente a cualquier colaborador por otros comportamientos que consideren inapropiados,
+amenazador, ofensivo o dañino.
+
+### Ámbito de aplicación
+
+Este Código de Conducta se aplica tanto en los espacios del proyecto como en los espacios públicos
+cuando una persona represente al proyecto o a su comunidad. Ejemplos de
+representación de un proyecto o comunidad incluyen el uso de una dirección de correo electrónico
+oficial del proyecto, la publicación a través de una cuenta oficial en las redes sociales o la
+representante designado en un evento en línea o fuera de línea. La representación de un proyecto puede
+definida y aclarada por los responsables del proyecto.
+
+### Cumplimiento
+
+Los casos de comportamiento abusivo, acosador o inaceptable pueden ser
+pueden notificarse poniéndose en contacto con el equipo del proyecto en [j.piedraprog@gmail.com]. Todas las
+quejas serán revisadas e investigadas y darán lugar a una respuesta que
+respuesta que se considere necesaria y adecuada a las circunstancias. El equipo del proyecto está
+obligado a mantener la confidencialidad con respecto al denunciante de un incidente.
+Podrán publicarse por separado más detalles sobre políticas de cumplimiento específicas.
+
+Los responsables del proyecto que no sigan o no hagan cumplir el Código de Conducta de buena fe pueden enfrentarse a repercusiones temporales o permanentes.
+buena fe pueden enfrentarse a repercusiones temporales o permanentes, según determinen otros
+miembros de la dirección del proyecto.
+

LICENSE

@@ -26,3 +26,34 @@ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+
+## BSD 3-Clause License traduction
+
+Copyright (c) 2023, Jose Piedra
+
+Se permite la redistribución y el uso en forma de código fuente y binaria, con o sin
+modificación, siempre que se cumplan las siguientes condiciones:
+
+1. 1. Las redistribuciones del código fuente deben conservar el aviso de copyright anterior, esta lista de condiciones y la siguiente cláusula de exención de responsabilidad.
+   lista de condiciones y el siguiente descargo de responsabilidad.
+
+2. Las redistribuciones en formato binario deben reproducir el aviso de copyright anterior
+   esta lista de condiciones y la siguiente cláusula de exención de responsabilidad en la documentación
+   y/u otros materiales proporcionados con la distribución.
+
+3. Ni el nombre del titular de los derechos de autor ni los nombres de sus
+   colaboradores pueden utilizarse para promocionar productos derivados de este
+   este software sin autorización previa por escrito.
+
+ESTE SOFTWARE ES PROPORCIONADO POR LOS TITULARES DE LOS DERECHOS DE AUTOR Y LOS COLABORADORES "TAL CUAL"
+Y CUALQUIER GARANTÍA EXPRESA O IMPLÍCITA, INCLUIDAS, ENTRE OTRAS, LAS
+GARANTÍAS IMPLÍCITAS DE COMERCIABILIDAD E IDONEIDAD PARA UN FIN DETERMINADO.
+SE DENIEGA. EN NINGÚN CASO EL TITULAR DE LOS DERECHOS DE AUTOR O LOS COLABORADORES SERÁN RESPONSABLES
+POR CUALQUIER DAÑO DIRECTO, INDIRECTO, INCIDENTAL, ESPECIAL, EJEMPLAR O CONSECUENTE
+(INCLUIDOS, ENTRE OTROS, LA ADQUISICIÓN DE BIENES O SERVICIOS DE SUSTITUCIÓN
+SERVICIOS; PÉRDIDA DE USO, DATOS O BENEFICIOS; O INTERRUPCIÓN DE LA ACTIVIDAD EMPRESARIAL), SIN
+CAUSADOS Y EN CUALQUIER TEORÍA DE RESPONSABILIDAD, YA SEA POR CONTRATO, RESPONSABILIDAD ESTRICTA
+O EXTRACONTRACTUAL (INCLUIDA LA NEGLIGENCIA O DE OTRO TIPO) QUE SURJA DE CUALQUIER MODO DEL USO
+DE ESTE SOFTWARE, AUN CUANDO SE HAYA ADVERTIDO DE LA POSIBILIDAD DE TALES DAÑOS.
+

README.md

@@ -1 +1,88 @@
-## API DE EDN USANDO NODE/EXPRESS/MONGODB
+
+![Logo](./img/icon.png)
+
+
+# API de Escuela de Nada 
+
+Esta es una API RESTful basada en el podcast Escuela de Nada. 
+Tendrás acceso a una base de datos con información de los mejores momentos, personajes y episodios que 
+se creen dentro del universo del podcast. También puedes agregar información y mantener actualizada la data. 
+
+
+
+
+## Documentación
+
+[Documentatión](https://docs.robotlandclub.com/docs)
+
+
+## Variables de Entorno
+
+Para ejecutar este proyecto, deberá añadir las siguientes variables de entorno a su archivo .env
+
+` ENVIRONMENT = [el entorno donde se va a ejecutar] `
+
+` JWT_PASS = [la key para desencriptar el jwt] `
+
+` MONGO_URL = [dirección de la base de datos] `
+
+` PORT = [ el puerto donde se va a ejecutar] `
+
+` HOST = [ de donde van a provenir las peticiones ] `
+
+` API_URL = 'https://api.robotlandclub.com/api' `
+
+` DOCS_URL = 'https://docs.robotlandclub.com' `
+
+
+
+## Úsalo localmente
+tienes que descargar e instalar [MongoDB](https://www.mongodb.com) y tener [Node](https://nodejs.org/es/).
+
+
+Clona el repositorio
+
+```bash
+  git clone https://link-to-project
+```
+
+Ve a donde se clono el proyecto
+
+```bash
+  cd my-project
+```
+
+Instala las dependencias
+
+```bash
+  npm install
+```
+
+Inicia el servidor
+
+```bash
+  npm run dev
+```
+
+
+
+
+## Contribuir al proyecto
+
+Esta es una api de código abierto asi que cualquier ayuda esta bienvenida.
+
+Puedes ver `contributing.md` para darte una idea por donde empezar.
+
+y también mantente apegado al ``code of conduct` si quieres colaborar con el proyecto.
+
+### Puedes ayudar a mantener el proyecto 
+
+[Ayuda a mantener el proyecto vivo](https://docs.robotlandclub.com/support)
+
+Si quieres conocer mas a cerca del proyecto puedes verlo [aquí](https://docs.robotlandclub.com/about)
+
+## Authors
+
+- [@piedraprog](https://www.github.com/octokatherine)
+
+

package.json

@@ -1,8 +1,8 @@
 {
   "name": "api_rest_edn",
-  "version": "1.0.0",
-  "description": "",
-  "main": "index.js",
+  "version": "1.0.0 pre-release",
+  "description": "This is a RESTful API based on the podcast Escuela de Nada",
+  "main": "./src/index.js",
   "scripts": {
     "dev": "nodemon src/index.js --exec babel-node",
     "build": "babel src --out-dir dist",