Bento/README.md

51 lines
1.6 KiB
Markdown
Raw Normal View History

2020-08-14 13:04:38 -05:00
2020-08-30 13:43:00 -05:00
<div align="center">
2020-08-30 21:21:04 -05:00
<h1>Bento: 🍱 A Clean and Simple Startpage</h1>
2020-08-30 13:43:00 -05:00
</div>
2020-08-14 13:04:38 -05:00
2020-08-30 13:35:13 -05:00
![](https://github.com/MiguelRAvila/Bento/blob/master/assets/preview.png)
2020-08-14 13:04:38 -05:00
2020-08-31 23:12:44 -05:00
### Index
- [Bento](#)
- [Features](#features)
- [Usage](#usage)
- [Home Page](#as-home-page)
- [New Tab](#as-new-tab)
- [Customization](#customization)
2020-08-14 13:04:38 -05:00
#### Features:
2020-08-30 01:56:01 -05:00
- **Dark/Light** mode, you can toggle them and It'll be saved in local store
2020-08-22 20:17:31 -05:00
- **Clock and Date** format can be set to 24 hour (default) or 12 hour
- **Greetings** are easy to change and modify
2020-08-14 13:04:38 -05:00
- **Variables** for custom colors in the `css` code
- **Modular** javascript files for an easy read
2020-08-30 13:35:13 -05:00
<p align="center">
<img src="https://github.com/MiguelRAvila/Bento/blob/master/assets/preview.gif">
</p>
2020-08-14 13:04:38 -05:00
### Usage:
2020-08-31 23:12:44 -05:00
#### As Home Page:
2020-08-14 13:04:38 -05:00
1. Fork this repo
2. Enable the Github Pages service `Settings > GitHub Pages > Source [master branch] > Save`
3. Set it as Home Page:
- Click the menu button. and select Options. Preferences.
- Click the Home panel.
2020-08-14 13:07:16 -05:00
- Click the menu next to Homepage and new windows and choose to show custom URLs and add your `Github Pages link`
2020-08-26 22:04:36 -05:00
2020-08-31 23:12:44 -05:00
### As New Tab:
1. You can use different Add-ons/Extensions for it
- If you use Firefox:[Custom New Tab Page](https://addons.mozilla.org/en-US/firefox/addon/custom-new-tab-page/?src=search)
- If you use Chromium (Brave, Vivaldi, Chrome): [Custom New Tab URL](https://chrome.google.com/webstore/detail/custom-new-tab-url/mmjbdbjnoablegbkcklggeknkfcjkjia)
### Customization
#### Colors
In the CSS code you can always change the variables for both themes (Dark and Light)
2020-08-26 22:06:55 -05:00
2020-08-31 23:12:44 -05:00
#### Weather Widget