summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6740481
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# The Morning Paper
+The Morning Paper is a project that prints out different information to a
+receipt printer in the morning. The project will include template modules for
+today's calendar events, the weather, a quote, top news headlines, and the
+national day.
+
+## Modules
+The modules provided are written in python and will use the [adafruit thermal
+printer library](https://github.com/adafruit/Python-Thermal-Printer) to
+interface with the
+[adafruit thermal printer used](https://www.adafruit.com/product/600).
+
+## TODO
+- Better line formatting
+- Switch to Adafruit Thermal print library
+- Stock Tracker
+- Better error handling
+- Test print page with ip address
+- Web interface for settings
+ - Settings print out with qr code to ip address
+
+## Parts
+- [Adafruit Thermal Printer](https://www.adafruit.com/product/600)
+- Microcontroller (I used a raspberry pi 4 but a zero w will work as well)
+
+## APIs used
+- [Quotable](https://quotable.io)
+- [National Weather Service](https://www.weather.gov/documentation/services-web-api)
+- [News API](https://newsapi.org/)
+- [National Day API](https://national-api-day.herokuapp.com) \ No newline at end of file