Update documentation

darekkay · Jan 17, 2020 · c2654cf · c2654cf
1 parent c4e7c9e
commit c2654cf
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 0 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -7,6 +7,7 @@
 The goal of this project is a fully customizable and extendable dashboard, with modules like clock, weather, todo tasks, bookmarks, calendar, etc. The user should be able to view all important information on a single page.
 
 - Create a browser start page with some common widgets.
+- Create public information displays.
 - Display company-related information on TVs around the office.
 - Display marketing information at an exhibition stand.
 - Brainstorm ideas using notes and images.

diff --git a/docs/changelog/README.md b/docs/changelog/README.md
@@ -3,6 +3,7 @@
 ## Unreleased
 
 - :bug: Let the Image always fit the whole widget.
+- :book: Update documentation.
 
 ## 1.1.3 (2020-01-14)
 

diff --git a/docs/development/README.md b/docs/development/README.md
@@ -12,6 +12,17 @@ This project was bootstrapped with [Create React App](https://github.com/faceboo
 - Styling: [SCSS](https://sass-lang.com/) with [Tailwind](https://tailwindcss.com/)
 - Dependency management: [yarn](https://yarnpkg.com)
 
+## Prerequisites
+
+Required:
+
+- Node.js 10+
+
+Recommended:
+
+- React Developer Tools (AddOn for [Chrome](https://chrome.google.com/webstore/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi) / [Firefox](https://addons.mozilla.org/en-US/firefox/addon/react-devtools/))
+- Redux DevTools (AddOn for [Chrome](https://chrome.google.com/webstore/detail/redux-devtools/lmhkpmbekcpmknklioeibfkpmmfibljd) / [Firefox](https://addons.mozilla.org/en-US/firefox/addon/reduxdevtools/))
+
 ## Installation
 
 Notice: You may also use `npm` instead of `yarn`.
@@ -71,6 +82,10 @@ The label keys can be viewed in a `debug` mode by adding `debug:labels` to the U
 
 Default UI language is based on the browser language and can be changed by the user in the settings dialog.
 
+## Browser support
+
+All current browsers are supported (Chrome, Firefox, Safari, Edge). IE11 is **not** supported, mostly due to the usage of [CSS Custom Properties](https://caniuse.com/#search=custom%20properties). I've tried using [a polyfill](https://github.com/nuxodin/ie11CustomProperties), but the results weren't great.
+
 ## Commit message format
 
 - Use imperative form (e.g. "Fix" instead of "Fixed" or "Fixes").

diff --git a/docs/widgets/README.md b/docs/widgets/README.md
@@ -21,6 +21,7 @@ Here's a list of widget ideas. They may or may not be implemented in the future.
 - Bookmarks, [Static Marks](https://darekkay.com/static-marks/)
 - Countdown, Timer
 - Counter
+- Calculator
 - Pomodoro Timer
 - Graphs
 - Video