diff --git a/README.md b/README.md index 52de788..263af61 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Moonraker - API Web Server for Klipper Moonraker is a Python 3 based web server that exposes APIs with which -client applications may use to interact with +client applications may use to interact with the 3D printing firmware [Klipper](https://github.com/KevinOConnor/klipper). Communcation between the Klippy host and Moonraker is done over a Unix Domain Socket. Tornado is used to provide Moonraker's server functionality. diff --git a/docs/index.md b/docs/index.md index 0f93305..77de29b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,5 +1,11 @@ # Welcome to Moonraker Documentation +Moonraker is a Python 3 based web server that exposes APIs with which +client applications may use to interact with the 3D printing firmware +[Klipper](https://github.com/KevinOConnor/klipper). Communcation between +the Klippy host and Moonraker is done over a Unix Domain Socket. Tornado +is used to provide Moonraker's server functionality. + Users should refer to the [Installation](installation.md) and [Configuration](configuration.md) sections for documentation on how to install and configure Moonraker.