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 etcher-cli + +# 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 pt \ No newline at end of file