From 552d561d3dd0abfe78517df71fb248f9559fe5b1 Mon Sep 17 00:00:00 2001
From: Nils <nils@byreqz.de>
Date: Thu, 20 Jan 2022 22:14:15 +0100
Subject: [PATCH] update readme

---
 README.md | 23 ++++++++++++++++++++++-
 1 file changed, 22 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 1f6a401..bbd05c9 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,22 @@
-# go-etcher
\ No newline at end of file
+# go-etcher
+
+go-etcher is a simple tool to create bootable drives that is mainly inspired by the deprecated  <a href="https://github.com/balena-io/etcher-cli">etcher-cli</a>
+
+# Usage
+```
+go-etcher [image] [device]
+```
+
+arguments: 
+```
+  -d, --device string   target device
+  -f, --force           override safety features
+  -i, --input string    input file
+```
+
+If no image or device is specified, etcher will enter interactive mode and prompt for the missing parameters.
+
+# Planned features
+- Windows support
+- prettier output
+- image OS detection via <a href="https://github.com/byReqz/pt">pt</a>
\ No newline at end of file