-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add extension description, directory structure, chrome APIs list, Scr…
…eenshots in README.md
- Loading branch information
1 parent
7c15c0a
commit 6048fc0
Showing
3 changed files
with
48 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,50 @@ | ||
*Mind me please!* | ||
--- | ||
Health reminders while working on the desk. | ||
|
||
- It's an extension that will help you to stay healthier while working on the desk. | ||
- It will nudge you to do essential small exercises when you are focused on your work and unconsciously forgetting the things. | ||
- Mind me please will periodically nudge you | ||
- fix your posture | ||
- blink your eyes | ||
- stretch your arms | ||
- drink some water | ||
- walk a bit | ||
- Individuals can set their reminder for any/all of the above. | ||
Chrome extension that will help you to stay healthier. It nudges you periodically to do essential small exercises when you are focused on your work and unconsciously forgetting to: | ||
- drink some water | ||
- stretch your arms | ||
- fix your posture | ||
- blink your eyes | ||
- walk a bit | ||
|
||
#### Getting Started: | ||
|
||
1. Set exercise(s)<br> | ||
![Alt Popup](./screenshots/popup.png?raw=true "Popup Window Screenshot") | ||
2. Receive notification<br> | ||
![Alt Notification](./screenshots/notification.png?raw=true "Notification Screenshot") | ||
|
||
#### Directory Structure: | ||
``` | ||
+ assets/ | ||
| + css/utilities.css | ||
| | | ||
| + png/icon*.png | ||
| | ||
+ dist/.. | ||
| | ||
+ inc/Notifications.js | ||
| | ||
+ popup/ | ||
| + index.html | ||
| | | ||
| + index.js | ||
| | ||
+ screenshots/.. | ||
| | ||
+ background.js | ||
| | ||
+ manifest.json | ||
| | ||
. | ||
. | ||
``` | ||
|
||
#### List of chrome APIs used: | ||
- [chrome.alarms](https://developer.chrome.com/docs/extensions/reference/alarms/) | ||
- [chrome.notifications](https://developer.chrome.com/docs/extensions/reference/notifications/) | ||
- [chrome.storage](https://developer.chrome.com/docs/extensions/reference/storage/) | ||
|
||
#### Contribution: | ||
If you have a patch or facing any issue, please consider contributing to this repository.<br> | ||
[Report Issue](https://github.com/Gauravbhatt19/Mind-me-please/issues/new) |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.