add docs

Author: carlosthe19916

README.md

@@ -6,7 +6,7 @@
 
 # XBuilder
 
-Java library for creating XML files based on UBL standards.
+Java library for creating and signing XML files based on UBL standards.
 
 XBuilder can be found in [Maven Central](https://mvnrepository.com/artifact/io.github.project-openubl/xbuilder)
 

docs/.gitignore

@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

docs/docs/create_xml.md

@@ -0,0 +1,29 @@
+---
+id: create_xml
+title: Create XML
+---
+
+Before creating an XML you need to decide which type of XML you will create; there are multiple types of XML files like:
+
+- Invoices
+- Credit notes
+- Debit notes, etc.
+
+Once you decided which type of document you want to create:
+
+- Create your input POJO
+- Send your POJO to `DocumentManager`
+
+```java
+// Create Invoice
+DocumentWrapper<InvoiceOutputModel> result = DocumentManager.createXML(input, config, systemClock);
+
+InvoiceOutputModel output = result.getOutput(); // XML Var values
+String xml = result.getXml(); // XML content
+```
+
+## A fully working example
+
+A fully working example of how to create an XML file is located in:
+
+- [Example](./example)

docs/docs/example.md

@@ -207,3 +207,18 @@ The content of the variable `xml` will be:
    </cac:InvoiceLine>
 </Invoice>
 ```
+
+## Sign XML
+
+For signing a XML you need to load your `X509Certificate` and `PrivateKey` using the method of your preference.
+
+```java
+String xml; // This is comes from the example above
+String signID = "mySignID"; // Your Signature ID
+
+// Get your certificate using the method of your preference
+X509Certificate certificate;
+PrivateKey privateKey;
+
+Document signedXML = XMLSigner.signXML(xml, signID, certificate, privateKey);
+```

docs/docs/sign_xml.md

@@ -0,0 +1,17 @@
+---
+id: sign_xml
+title: Sign XML
+---
+
+For signing a XML you need to load your `X509Certificate` and `PrivateKey` using the method of your preference.
+
+```java
+String xml; // Use docs for create an XML
+String signID = "mySignID"; // Your Signature ID
+
+// Get your certificate using the method of your preference
+X509Certificate certificate;
+PrivateKey privateKey;
+
+Document signedXML = XMLSigner.signXML(xml, signID, certificate, privateKey);
+```

docs/docusaurus.config.js

@@ -1,6 +1,6 @@
 module.exports = {
   title: "XBuilder",
-  tagline: "Java library for creating XML files based on Universal Bussiness Language (UBL)",
+  tagline: "Java library for creating and signing XML files based on Universal Bussiness Language (UBL)",
   url: "https://project-openubl.github.io/xbuilder-docs/",
   baseUrl: "/xbuilder-docs/",
   favicon: "img/favicon.ico",
@@ -86,13 +86,13 @@ module.exports = {
           sidebarPath: require.resolve("./sidebars.js"),
           // Please change this to your repo.
           editUrl:
-            "https://github.com/facebook/docusaurus/edit/master/website/",
+            "https://github.com/project-openubl/xbuilder/edit/master/docs/",
         },
         blog: {
           showReadingTime: true,
           // Please change this to your repo.
           editUrl:
-            "https://github.com/facebook/docusaurus/edit/master/website/blog/",
+            "https://github.com/project-openubl/xbuilder/edit/master/docs/blog/",
         },
         theme: {
           customCss: require.resolve("./src/css/custom.css"),

docs/sidebars.js

@@ -2,6 +2,6 @@ module.exports = {
   someSidebar: {
     XBuilder: ["introduction", "design_principles", "contributing"],
     "Getting started": ["installation", "example"],
-    Guides: ["concepts"],
+    Guides: ["concepts", "create_xml", "sign_xml"],
   },
 };

docs/src/pages/index.js

@@ -63,7 +63,7 @@ function Home() {
   return (
     <Layout
       title={`${siteConfig.title}`}
-      description="Java library for creating XML files based on Universal Bussiness Language (UBL) <head />"
+      description="Java library for creating and signing XML files based on Universal Bussiness Language (UBL) <head />"
     >
       <header className={clsx("hero hero--primary", styles.heroBanner)}>
         <div className="container">