From 3223e580a7e73dd549df622d6d77a23d3ef237a7 Mon Sep 17 00:00:00 2001
From: martijn <martijnremmen@hotmail.nl>
Date: Thu, 26 May 2022 23:45:30 +0200
Subject: [PATCH] readme geschreven

---
 README.md | 45 ++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 44 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index da3d0cb..b9a3138 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,46 @@
 # Ansible Collection - kembit.topdesk
 
-Documentation for the collection.
+Deze repository bevat een Proof of Concept inventory plugin voor Ansible. Deze plugin zorgt ervoor dat TOPdesk Asset Management als bron kan worden gebruikt voor het genereren van een inventory voor Ansible.
+
+## Installatie
+
+1. Zorg ervoor dat je Ansible geïnstalleerd hebt.
+2. Maak in je projectfolder een bestand `requirements.yaml` als je dat nog niet hebt. In dit bestand kun je collections zetten die je gebruikt ([zie de documentatie](https://galaxy.ansible.com/docs/using/installing.html))
+3. Zorg ervoor dat je deze collection opneemt als requirement. Zoals hieronder
+4. Voer `ansible-galaxy collection install -r requirements.yaml` uit om alle requirements te installeren.
+
+```yaml
+collections:
+  - name: https://git.remmen.net/Thesis/kembit.topdesk
+    version: v1.0
+    type: git
+```
+
+## Gebruik
+
+Je kunt nu de inventory plugin gebruiken in een inventory bestand. Maak een nieuw bestand aan genaamd `inventory.yaml` die er bijvoorbeeld als volgt uitziet:
+
+```yaml
+plugin: kembit.topdesk.topdesk_am
+
+url: <url van de TOPdesk installatie (zonder slash op het einde)>
+username: <gebruikersnaam (met rechten tot asset management)>
+application_key: <een applicatie key (zie https://developers.topdesk.com/tutorial.html)>
+
+fields:
+  - name
+  - type
+  - merk
+  - serienummer
+  - lokaal-ipadres
+  - status
+  - beheer-ipadres
+  - contract
+
+names:
+  - KMB-SW300
+  - KMB-SW191
+  - KMB-SW318
+
+ansible_host: beheer-ipadres
+```
\ No newline at end of file