From b55a7b4f95c53cd24d806571792ad0548925c637 Mon Sep 17 00:00:00 2001
From: Hermsi1337 <info@hermsi.codes>
Date: Wed, 18 Oct 2017 08:55:05 +0200
Subject: [PATCH] Add README.md for some documentation

---
 README.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..20c6b20
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# Make your OpenSSH fly on Alpine
+
+## Overview
+Use this Dockerfile / -image to start a sshd-server upon a lightweight Alpine container. <br>
+
+### Features
+* Always installs the latest OpenSSH-Version available for Alpine
+* Password of "root"-user can be changed when starting the container using --env
+
+### Basic Usage
+```
+$ docker run --rm \
+--publish=1337:22 --env ROOT_PASSWORD=MyRootPW!23 \
+hermsi/alpine-sshd
+```
+
+### Use with docker-compose
+I built this image in order to use it along with a nginx and fpm-php container for transferring files via sftp. <br>
+If you are interested in a Dockerfile which fulfills this need: [this way](https://github.com/Hermsi1337/docker-compose/blob/master/full_php_dev_stack/docker-compose.yml)
\ No newline at end of file