Files
browser-wakatime/README.md
Vu Nguyen 9ef655ac3b Setup CI tests (#100)
* use @xarc/xrun to streamline tasks in an imperative manner

* add lint-staged/husky for git hook tasks

* run prettier across all files

* fixing tests

* add ci test workflow

* add a ci workflow

* remove precommit in favor of husky

* add .prettierrc.js

* reformat with prettier
2021-01-13 21:05:05 -08:00

81 lines
1.7 KiB
Markdown

# chrome-wakatime
Automatic time tracking for stats about your website debugging, research, documentation, etc.
Note: Activity from this Chrome extension will not display on leaderboards, so installing this extension may lower your rank.
## Installation
1. Install the extension:
[![Chrome Web Store](https://wakatime.com/static/img/chrome-web-store.png)](https://chrome.google.com/webstore/detail/wakatime/jnbbnacmeggbgdjgaoojpmhdlkkpblgi)
2. Login to [WakaTime](https://wakatime.com/).
3. Use Chrome like you normally do and your time will be tracked for you automatically.
4. Visit https://wakatime.com to see your logged time.
5. Use in conjunction with [other WakaTime plugins](https://wakatime.com/plugins).
## Screenshots
![SC open](./screenshots/sc_6-green.png)
![SC open](./screenshots/sc_6-open.png)
![Options SC](./screenshots/sc_8-options.png)
## Development instructions
> For development purposes only.
To get started, install NPM and Bower dependencies, and do an initial build with Gulp:
```
npm start
```
To build the extension once:
```
npm run gulp
```
To monitor changes:
```
npm run watch
```
Run tests:
```
npm test
```
Lint code _(Both JS and JSX)_:
```
jsxhint --jsx-only .
```
### Automatic code linting
There is a precommit hook that lints the code before commiting the changes.
### Load unpacked in Chrome
1. Clone repository to disk
2. Remove `browser_specific_settings` key from manifest.json (only necessary for firefox)
3. Go to `Settings``Extensions`
4. Enable `Developer mode`
5. Click `Load unpacked extension...`
6. Select repository directory
### Troubleshooting
Check for errors by inspecting the extension.
![inspecting extension](./screenshots/wakatime-chrome-debug.gif)