📝 Adding repo documentation (#23)

* 📝 Adding repo documentation

* 🔧 Updating GithubActions

.github/workflows/pmd.yml

@@ -25,10 +25,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-      - name: Set up JDK 21
+      - name: Set up JDK 22
         uses: actions/setup-java@v3
         with:
-          java-version: '21'
+          java-version: '22'
           distribution: 'temurin'
       - name: Run PMD
         id: pmd

README.md

@@ -0,0 +1,69 @@
+Se trata de un repositorio creado para ejercitar contenidos del curso De 
+DevOps a DevSecOps: seguridad en los procesos da [IEBS](https://www.iebschool.com/).
+
+El proyecto en sí es una implementación API-First que utiliza Java, 
+Springboot y Gradle. A través de una especificación OpenAPI, se genera una interfaz 
+Java para que los controladores creados estén alineados con la especificación API 
+propuesta en la carpeta **build**.
+
+```
+.
+├── build
+│     └── generate-resources
+│           └── main
+│               ├── pom.xml
+│               ├── README.md
+│               └── src
+│                   └── main
+│                       └── java
+│                           └── org
+│                               └── openapitools
+│                                   ├── api
+│                                   │     ├── ApiUtil.java
+│                                   │     └── BatidasApi.java
+│                                   └── model
+│                                       ├── Mensagem.java
+│                                       └── Momento.java
+├── build.gradle.kts
+├── gradle
+│     └── wrapper
+├── gradle.properties
+├── gradlew
+├── gradlew.bat
+├── plugins
+│     ├── java.gradle
+│     └── openapi.gradle
+├── README.md
+├── settings.gradle.kts
+└── src
+    ├── main
+    │     ├── java
+    │     │     └── com
+    │     │         └── arthurfnsc
+    │     │             └── apifirst
+    │     │                 ├── ApiFirstApplication.java
+    │     │                 └── rest
+    │     │                     └── FolhaPontoController.java
+    │     └── resources
+    │         ├── application.properties
+    │         └── openapi
+    │             └── folha_ponto-api.yaml
+    └── test
+        └── java
+```
+
+Para generar la interfaz, ejecute el siguiente comando:
+
+```
+./gradlew clean compileJava
+```
+
+Aunque el curso está dirigido a los pasos de DevSecOps, no tengo la experiencia para 
+definir el mejor enfoque para las herramientas SAST, DAST y definir el sombreado entre 
+opciones, por lo que agregué varias GithubActions para validar algunos conceptos en la 
+pipeline.
+
+En el futuro, el repositorio puede sufrir cambios no necesariamente relacionados con la 
+parte de seguridad, pero la pipeline de CI/CD y el contexto de seguridad permanecerán. 
+Debido a que agregaste varias GithubActions en confirmaciones futuras, es posible que 
+algunas de ellas se modifiquen sean eliminadas.