Update Readme and plugin description

om2804 · Jul 31, 2022 · a9808e2 · a9808e2
1 parent 5398e23
commit a9808e2
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,14 @@
-# octoprint_mkswifisdcard
+# octoprint_mkswifisdcard
+
+## Description
+Octoprint plugin for fast upload file to SD-card over <a href="https://github.com/makerbase-mks/MKS-WIFI"> MKS WiFi module</a>
+
+Uploading file to SD-card over serial connection is very slow. Uploading file over WiFi connection is fast.
+
+Tested on Flying Bear Ghost 5.
+
+## Settings
+Set Host or IP WiFi module printer in settings plugin.
+
+## Additional
+<a href="https://github.com/hellerbarde/OctoPrint-Network-Printing">OctoPrint-Network-Printing</a> to use the Python-internal serial-over-network functionality to connect to a 3d printer over WiFi.
diff --git a/setup.py b/setup.py
@@ -18,7 +18,7 @@
 
 # The plugin's description. Can be overwritten within OctoPrint's internal data via __plugin_description__ in the plugin
 # module
-plugin_description = """A simple plugin for download to sd card via MKS wifi¨"""
+plugin_description = """Octoprint plugin for fast upload file to SD-card over MKS WiFi module"""
 
 # The plugin's author. Can be overwritten within OctoPrint's internal data via __plugin_author__ in the plugin module
 plugin_author = "om2804"