aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b6d71f1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# New Tab
+My new tab landing page
+
+Features links to my most popular sites, with a config for any sites that are self hosted (as to not link to my own) and to hide some personal information.
+
+The weather and a 3 day forecast is also displayed.
+
+# Set up
+Host the files on a web server. Rename `template-config.js` to `config.js`, and fill in the values as needed.
+
+# TO DO
+- Update weather at most once per hour
+- Style forecast table better
+- Show green/red status indicator for sites (also to update on the hour)
+