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

Updated README with changes.

Browse Source
This commit is contained in:
deepjyoti30
2020-05-16 13:12:11 +05:30
parent 95fde6f0ec
commit 4f618a96b6
1 changed files with 27 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
README.md
View File

@@ -1,36 +1,36 @@
# Minimal Startpage
Just another minimal startpage for browsers.
<div align="center">
<h1>Minimal Startpage</h1>
<h4>Just another minimal startpage for browsers.</h4>
</div>
<img src=".github/startpage.gif">
## How to Use
<div align="center">
<br>
<img src="https://img.shields.io/badge/Maintained%3F-Yes-blueviolet?style=for-the-badge">
<a href="LICENSE.md"><img src="https://img.shields.io/badge/License-MIT-pink.svg?style=for-the-badge"></a> <a href="http://makeapullrequest.com"><img src="https://img.shields.io/badge/PRs-welcome-lightblue.svg?style=for-the-badge"></a> <img src="https://img.shields.io/badge/supports-chrome-lightgreen.svg?style=for-the-badge"> <img src="https://img.shields.io/badge/supports-firefox-orange.svg?style=for-the-badge">
- Clone the repo
```console
git clone https://github.com/deepjyoti30/startpage
```
<p>
<a href="https://ko-fi.com/deepjyoti30"><img src="https://raw.githubusercontent.com/adi1090x/files/master/other/kofi.png" alt="Support me on ko-fi"></a>
</p>
</div>
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 | \<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. |
## Support the project
If you like using this app, consider supporting the project/me
<p align="left">
<a href="https://www.paypal.me/deepjyoti30" target="_blank"><img alt="undefined" src="https://img.shields.io/badge/paypal-deepjyoti30-blue?style=for-the-badge&logo=paypal"></a>
<a href="https://ko-fi.com/deepjyoti30" target="_blank"><img alt="undefined" src="https://img.shields.io/badge/KoFi-deepjyoti30-red?style=for-the-badge&logo=ko-fi"></a>
</p>