diff --git a/readme.md b/readme.md index 198ee88..c860b8e 100644 --- a/readme.md +++ b/readme.md @@ -1,12 +1,19 @@ -# A new branch to rebuild this entire application using: - +# My personal website build with the following web technologies - ReactJS - GoLang Server +- MongoDB - Hosted on Digital Ocean +## Sensors +I have ESP8266 microcontrollers with DS18B20 digital temperature sensors attached to the server. +Sensor information is stored in MongoDB. [ChartJS](http://www.chartjs.org/) is the library used to display information in graphs. + +## How posts are loaded - metadata.js recursivly scans the posts folder for markdown files and then parses each into into a json object - the posts folder is then copied into the dist folder +[More information here](http://mitchel.io/post/Web%20Stuff/2016-09-19-loading-content) +## Installation - `npm run deploy` - installs go/npm dependencies - builds Go files into executable @@ -14,8 +21,8 @@ - parses markdown files with metadata.js - executes server binary -## TODO +### TODO +- clean up webpack for debug/production builds - sticky footer -- clean up css - adjust/remove? animations - fix go and webpack-dev-server so paths work correctly