Skip to content

Commit 468c6e4

Browse files
committed
docs: basic readme filled in
1 parent 3fc06ec commit 468c6e4

File tree

1 file changed

+2
-6
lines changed

1 file changed

+2
-6
lines changed

README.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# OctoPrint-HeaderAnnouncements
2-
3-
**TODO:** Describe what your plugin does.
2+
In a shared environment like a maker space or lab, it can be useful to be able to notify users of upcoming changes, maintenance, procedures, etc. This plugin allows you to set a header that will be displayed at the top of the page for users to see.
43

54
## Setup
65

@@ -9,9 +8,6 @@ or manually using this URL:
98

109
https://github.com/wwsean08/OctoPrint-HeaderAnnouncements/archive/master.zip
1110

12-
**TODO:** Describe how to install your plugin, if more needs to be done than just installing it via pip or through
13-
the plugin manager.
14-
1511
## Configuration
1612

17-
**TODO:** Describe your plugin's configuration options (if any).
13+
* Announcement: The announcement to display. If you update this after someone has loaded the page, they will receive the new announcement within 1 minute replacing the existing one.

0 commit comments

Comments
 (0)