From b6050b0c2f22e0675df0f0ea3f180d7ddf264552 Mon Sep 17 00:00:00 2001
From: Nicolai Ort <info@nicolai-ort.com>
Date: Thu, 31 Dec 2020 16:27:26 +0100
Subject: [PATCH] Fresh new readme

---
 README.md | 31 +++++++++++++++++++++++++++++--
 1 file changed, 29 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index e2052c3..c9c2829 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,30 @@
-# license-exporter
+# ODIT.Services - License Exporter
 
-A simple license exporter that crawls your npm dependencies for their licenses.
\ No newline at end of file
+[![Build Status](https://ci.odit.services/api/badges/odit/license-exporter/status.svg?ref=refs/heads/main)](https://ci.odit.services/odit/license-exporter)
+
+A simple license exporter that crawls your package.json and provides you with information about your dependencies' licenses.
+You can export this information into json and markdown.
+
+## Install
+Via yarn/npm:
+```bash
+yarn add @odit/license-exporter
+# Or
+npm i @odit/license-exporter
+```
+
+## Use
+
+Export only your dependencies to json: `license-exporter --json`
+Export all dependencies to json: `license-exporter --json --recursive`
+
+Export only your dependencies to markdown: `license-exporter --md`
+Export all dependencies to markdown: `license-exporter --md --recursive`
+
+## Arguments
+Arg | Description
+-|-
+`--help` | View the help dialog
+`--recursive`| Include all dependencies' subdependencies
+`--json` | Exports the license information into ./licenses.json as json
+`--md` | Exports the license information into ./licenses.md as markdow
\ No newline at end of file