diff --git a/README.md b/README.md index ebfaf4a..1163f52 100644 --- a/README.md +++ b/README.md @@ -35,3 +35,15 @@ I thought I would work on adding a settings page that would handle the updating ## Settings For the time being you need to edit the ```config.json``` file present in the root directory of the repo and then install the extension by following the above steps. + +| Name | Supported Values | Default | Description | +| ---- | ----- | ------- | ------ | +| searchEngine | \ | DuckDuckGo | Search Engine to use for searching from the bar | +| user | string | Deepjyoti (That's my name) | Name of the user to use on the welcome message | +| disableMessage | \ | false | Hide the Welcome message | +| disableDate | \ | false | Hide the date | +| disableSearchBar | \ | false | Hide the search bar | +| disable24Hour | \ | true | Disable 24 hour clock and show time in 12 hour format | +| disableWeather | \ | true | Disable the weather beside the date | +| weatherConf | Object (Check default for child keys) | {"location": "Pune India","unit": "fah"}| Configuration for the weather, location and unit etc. In "unit", "fah" is short for Fahrenheit and "cel" for Celcius, however the whole word can also be passed. | +| squares | Object of arrays | Check [config.json](https://github.com/deepjyoti30/startpage/blob/master/config.json) for default values | Values and Names of shortcuts for the cards. | diff --git a/config.json b/config.json index e765b1f..cb9ddbc 100644 --- a/config.json +++ b/config.json @@ -35,7 +35,7 @@ "disableDate": false, "disableSearchBar": false, "disable24Hour": false, - "disableWeather": false, + "disableWeather": true, "weatherConf": { "location": "Pune India", "unit": "fah"