kawa/startpage-onedark
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated README with instructions related to values availabe in config.json

Browse Source
This commit is contained in:
deepjyoti30
2020-05-15 23:11:32 +05:30
parent 4a96ec2b92
commit e73ecaab4a
2 changed files with 13 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -35,3 +35,15 @@ I thought I would work on adding a settings page that would handle the updating
## Settings ## 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. 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 \| Google \| Bing \|Yahoo\> | 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 \| true\> | false | Hide the Welcome message |
| disableDate | \<false \| true\> | false | Hide the date |
| disableSearchBar | \<false \| true\> | false | Hide the search bar |
| disable24Hour | \<false \| true\> | true | Disable 24 hour clock and show time in 12 hour format |
| disableWeather | \<false \| true\> | 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. |

2
config.json
View File

@@ -35,7 +35,7 @@
"disableDate": false, "disableDate": false,
"disableSearchBar": false, "disableSearchBar": false,
"disable24Hour": false, "disable24Hour": false,
"disableWeather": false, "disableWeather": true,
"weatherConf": { "weatherConf": {
"location": "Pune India", "location": "Pune India",
"unit": "fah" "unit": "fah"