diff --git a/README.md b/README.md index 376fbd1..34f7d49 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,36 @@ -# Minimal Startpage - -Just another minimal startpage for browsers. +
+

Minimal Startpage

+

Just another minimal startpage for browsers.

+
-## How to Use +
+
+ + -- Clone the repo - ```console - git clone https://github.com/deepjyoti30/startpage - ``` +

+Support me on ko-fi +

+
- Alternately, you can download and extract from the browser. +## Installation ### Chrome +- Get the latest release (zip) or clone this repo and extract it. - On chrome, open extensions from the tool menu or open it from [chrome://extensions](chrome://extensions). - Click on load unpacked, navigate to the directory where you cloned the repo and select it. -### Firefox (temporary) +>NOTE: You can also install using the ```crx``` file provided in the release. -- Open ```about:debugging``` from your Firefox browser. -- Click on This Firefox and select ```Load Temporary Add On...``` -- Open the cloned repo directory and select any file there (preferrably ```manifest.json```) -- It should be installed. +### Firefox -## Upcoming +Submitted to addons.mozilla.org, I will update the README once the addon is approved. -Will be availabe on Firefox and Chrome add on stores in a while. - -I thought I would work on adding a settings page that would handle the updating the settings but I'm just way to bored and honestly I've come to realize I hate GUI's (I mean I've always loved CLI based apps). Anyway, the extension can still be used and I'm sure the crowd I aimed this extension at knows how to edit a ```json``` file, for the time being I'll just let you guys install it and use it and edit the settings from the ```config```. +Check [here](https://addons.mozilla.org/en-US/firefox/addon/minimal-startpage/). Should be available in a while. ## Settings @@ -49,3 +49,12 @@ A JSON editor will open up where you can make the changes. | 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. | + +## Support the project + +If you like using this app, consider supporting the project/me + +

+undefined +undefined +