diff --git a/README.md b/README.md index d644160..2f65d4b 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,14 @@ -# Simple Serial Console -_replace `ssc` with the name of your binary, e.g. `ssc-windows-amd64` or `ssc-linux-arm64`_ +# Simple Serial Console (SSC) +SSC is exactly what you think it is: A serial console without bloat. +For simple communication you don't need anything else! You can use it to control most 3D-printers, an Arduino and loads more. + +You only need to know two things: +1. The baud rate the device expects, which you can usually define manually or find somewhere in the info screen +2. The line endings the device expects. It's not always documented, but usually starting with the default (`LF`) works. + ## Usage +_replace `ssc` with the name of your binary, e.g. `ssc-windows-amd64` or `ssc-linux-arm64`, or rename your binary to `ssc`_ ``` ssc [] [] ```