From 63b77842cf17e20cf6d3e0db8d9c71197b28097c Mon Sep 17 00:00:00 2001
From: Jan Dittberner <jan@dittberner.info>
Date: Sun, 22 Jan 2023 13:23:27 +0100
Subject: [PATCH] Update README

- update input and output examples
- add license text
---
 README.md | 26 +++++++++++++++++++++-----
 1 file changed, 21 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index dfe382a..d3c7d0f 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,21 @@ this can be used to trigger registry-image or docker-image builds when security
 
 The source code for the resource type is available at https://git.dittberner.info/jan/concourse-dsa-resource
 
+## License
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
 ## Usage
 
 To use the resource type in your own Concourse pipeline you will have to define the resource type and a resource:
@@ -50,11 +65,11 @@ shortened and pretty-printed example output looks like this:
   [
     {
       "date": "2023-01-18",
-      "title": "DSA-5322 firefox-esr"
+      "title": "DSA-5322"
     },
     {
       "date": "2023-01-19",
-      "title": "DSA-5323 libitext5-java"
+      "title": "DSA-5323"
     }
   ]
   ```
@@ -72,7 +87,7 @@ metadata. If the version exists. The following input example returns the output
     "params": {},
     "version": {
       "date": "2023-01-18",
-      "title": "DSA-5322 firefox-esr"
+      "title": "DSA-5322"
     }
   }
   ```
@@ -83,11 +98,12 @@ metadata. If the version exists. The following input example returns the output
   {
     "version": {
       "date": "2023-01-18",
-      "title": "DSA-5322 firefox-esr"
+      "dsa": "DSA-5322"
     },
     "metadata": {
       "link": "https://www.debian.org/security/2023/dsa-5322",
-      "description": "security update"
+      "package": "firefox-esr",
+      "description": "Multiple security issues have been found in the Mozilla Firefox web\nbrowser, which could potentially result in the execution of arbitrary\ncode, information disclosure or spoofing."
     }
   }
   ```
\ No newline at end of file