Improving docs (#91)

* Improving docs

* Improving checklist

Author: jabrena

CHANGELOG.md

@@ -5,11 +5,16 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [0.4.0-SNAPSHOT] - Unreleased
+## [0.4.0] - 2025-02-23
 
 ### Added
 
-- PML CLI tool (`pml`) for command-line operations with PML files
+- PML CLI tool (`pml`) for command-line operations with PML files (validate and convert commands)
+- `description` field in metadata element for PML schema (#89) to support Skills
+
+### Removed
+
+- `instructions` element from PML schema (#89) — use `metadata/description` instead
 
 ## [0.3.0] - 2025-11-10
 
@@ -45,3 +50,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Deprecated
 - `instructions` element in PML schema (marked for deprecation in future releases)
+
+[0.4.0]: https://github.com/jabrena/pml/compare/0.3.0...0.4.0
+[0.3.0]: https://github.com/jabrena/pml/compare/0.2.0...0.3.0
+[0.2.0]: https://github.com/jabrena/pml/compare/0.1.0...0.2.0

README.md

@@ -23,7 +23,7 @@ Java software engineers use XML daily because `Maven` is based on XML and it has
 
     <groupId>info.jab.pml</groupId>
     <artifactId>prompt-markup-language</artifactId>
-    <version>0.3.0</version>
+    <version>0.4.0</version>
     <packaging>pom</packaging>
 
     <name>prompt-markup-language</name>
@@ -144,7 +144,7 @@ In your prompts, you could have to include scripts like in this prompt:
 ```xml
 <?xml version="1.0" encoding="UTF-8"?>
 <prompt xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xsi:noNamespaceSchemaLocation="https://jabrena.github.io/pml/schemas/0.3.0/pml.xsd">
+    xsi:noNamespaceSchemaLocation="https://jabrena.github.io/pml/schemas/0.4.0/pml.xsd">
     <title>Install Java 25 in Cursor Cloud Agent</title>
 
     <role>System Administrator with expertise in Java development environments and package management for Linux systems</role>
@@ -223,7 +223,7 @@ Prompts can be defined in 3 different ways:
 ```xml
 <?xml version="1.0" encoding="UTF-8"?>
 <pml-workflow xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-              xsi:noNamespaceSchemaLocation="https://jabrena.github.io/pml/schemas/0.3.0-SNAPSHOT/pml-workflow.xsd">
+              xsi:noNamespaceSchemaLocation="https://jabrena.github.io/pml/schemas/0.4.0/pml-workflow.xsd">
     <parallel src="prompt-toc.xml" bindResultType="List_Integer">
         <sequence model="default" repository="https://github.com/jabrena/wjax25-demos">
             <prompt src="prompt2.xml" bindResultExp="$get()"/>
@@ -238,10 +238,10 @@ The repository provides a CLI tool to convert PML files into Markdown in an easy
 
 ```bash
 ./mvnw clean package
-java -jar cli/target/pml-to-md-0.4.0-SNAPSHOT.jar --help
-java -jar cli/target/pml-to-md-0.4.0-SNAPSHOT.jar validate cli/src/test/resources/pml/pml-hello-world.xml
-java -jar cli/target/pml-to-md-0.4.0-SNAPSHOT.jar convert cli/src/test/resources/pml/pml-hello-world-template.xml --template MESSAGE "Hello World"
-java -jar cli/target/pml-to-md-0.4.0-SNAPSHOT.jar convert cli/src/test/resources/pml/pml-hello-world-template-multiple.xml --template MESSAGE "Hello World" CHANNEL "Console"
+java -jar cli/target/pml-to-md-0.4.0.jar --help
+java -jar cli/target/pml-to-md-0.4.0.jar validate cli/src/test/resources/pml/pml-hello-world.xml
+java -jar cli/target/pml-to-md-0.4.0.jar convert cli/src/test/resources/pml/pml-hello-world-template.xml --template MESSAGE "Hello World"
+java -jar cli/target/pml-to-md-0.4.0.jar convert cli/src/test/resources/pml/pml-hello-world-template-multiple.xml --template MESSAGE "Hello World" CHANNEL "Console"
 ```
 
 ## Java Bindings

cli/pom.xml

@@ -68,7 +68,7 @@
                                 <resource>
                                     <directory>../schema/src/main/resources</directory>
                                     <includes>
-                                        <include>*.xsd</include>
+                                        <include>pml.xsd</include>
                                     </includes>
                                 </resource>
                             </resources>

cli/src/main/resources/pml.xsd

@@ -13,7 +13,6 @@
                 <xs:element ref="context" minOccurs="0"/>
                 <xs:element ref="goal"/>
                 <xs:element ref="constraints" minOccurs="0"/>
-                <xs:element ref="instructions" minOccurs="0"/><!-- TODO: To be deprecated in the next releases (29/10/2025) -->
                 <xs:element ref="steps" minOccurs="0" />
                 <xs:element ref="examples" minOccurs="0"/>
                 <xs:element ref="output-format" minOccurs="0"/>
@@ -59,15 +58,6 @@
         </xs:complexType>
     </xs:element>
 
-    <!-- Instructions section -->
-    <xs:element name="instructions">
-        <xs:complexType>
-            <xs:sequence>
-                <xs:element ref="steps"/>
-            </xs:sequence>
-        </xs:complexType>
-    </xs:element>
-
     <!-- Steps container -->
     <xs:element name="steps">
         <xs:complexType>