From 02dddfbcbc8be2b56c4eac194c0fcdea5c87559e Mon Sep 17 00:00:00 2001
From: Mitchell Berendhuysen <45570310+MitchellBerend@users.noreply.github.com>
Date: Sun, 16 Oct 2022 14:53:28 +0200
Subject: [PATCH] added readme and license files (#18)

---
 CHANGELOG.md |  5 +++--
 LICENSE      | 19 +++++++++++++++++++
 README.md    | 12 ++++++++++++
 3 files changed, 34 insertions(+), 2 deletions(-)
 create mode 100644 LICENSE
 create mode 100644 README.md

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 07655e8..69c6603 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,7 +1,8 @@
 ## Added
 
-[[#11](https://github.com/MitchellBerend/docker-manager/issues/11)]Implement images command and all its flags
-
+[[#11](https://github.com/MitchellBerend/docker-manager/issues/11)] Implement images command and all its flags
+[[#17](https://github.com/MitchellBerend/docker-manager/pull/17)] Added shell completion generation
+[[#18](https://github.com/MitchellBerend/docker-manager/pull/18)] Added readme and license
 
 
 v0.0.3
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..56844f6
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,19 @@
+Copyright (c) 2022 Mitchell Berendhuysen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..22e1f78
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+# Quick start
+
+1. Download the latests [release](https://github.com/MitchellBerend/docker-manager/releases).
+2. Ensure the user you log in with has sudo rights.
+3. Run `docker-manager completion --help` to set up auto completion for your
+shell
+4. Run `docker-manager ps`
+
+# Goals
+This project aims to have an easier way to interact with docker containers on
+remote nodes from the comfort of your own terminal. The aim for this project is
+to support all docker commands on remote nodes.