3diy
/
moonraker
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

readme: Add link to Read The Docs 

Update the links for user changes and api changes.

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
This commit is contained in:
Arksine 2021-03-16 08:35:18 -04:00
parent dc60143ef8
commit 1615af731b
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -1,16 +1,21 @@
# Moonraker - API Web Server for Klipper # Moonraker - API Web Server for Klipper
Moonraker is a Python 3 based web server that exposes APIs with which Moonraker is a Python 3 based web server that exposes APIs with which
client applications may use to interact with [Klipper](https://github.com/KevinOConnor/klipper). Communcation between client applications may use to interact with
[Klipper](https://github.com/KevinOConnor/klipper). Communcation between
the Klippy host and Moonraker is done over a Unix Domain Socket. Tornado the Klippy host and Moonraker is done over a Unix Domain Socket. Tornado
is used to provide Moonraker's server functionality. is used to provide Moonraker's server functionality.
Documentation for users and developers can be found on
[Read the Docs](https://moonraker.readthedocs.io/en/latest/).
Note that Moonraker does not come bundled with a client, you will need to Note that Moonraker does not come bundled with a client, you will need to
install one. The following clients are currently available: install one. The following clients are currently available:
- [Mainsail](https://github.com/meteyou/mainsail) by Meteyou - [Mainsail](https://github.com/meteyou/mainsail) by Meteyou
- [Fluidd](https://github.com/cadriel/fluidd) by Cadriel - [Fluidd](https://github.com/cadriel/fluidd) by Cadriel
- [KlipperScreen](https://github.com/jordanruthe/KlipperScreen) by jordanruthe - [KlipperScreen](https://github.com/jordanruthe/KlipperScreen) by jordanruthe
### Changes ### Changes
This section contains changelogs that users and developers may reference This section contains changelogs that users and developers may reference
@ -18,7 +23,7 @@ to see if any action is necessary on their part. The date of the most
recent change is included. recent change is included.
Users:\ Users:\
[user_changes.md](/docs/user_changes.md) - March 10th 2021 [user_changes.md](https://moonraker.readthedocs.io/en/latest/user_changes/) - March 10th 2021
Developers:\ Developers:\
[api_changes.md](/docs/api_changes.md) - March 15th 2021 [api_changes.md](https://moonraker.readthedocs.io/en/latest/api_changes/) - March 15th 2021