-
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.
docs: Update README to reflect project name and installation instruct…
…ions for Open Browser Time
- Loading branch information
Showing
1 changed file
with
14 additions
and
45 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,50 +1,19 @@ | ||
# React + TypeScript + Vite | ||
# Open Browser Time | ||
Open Browser Time is an open-source tool designed to record and analyze browser visit times. It helps users track their time spent on websites, aiding in better time management. | ||
|
||
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules. | ||
## Features | ||
|
||
Currently, two official plugins are available: | ||
- **Time Tracking**: Automatically records the time spent on each website. | ||
- **Detailed Reports**: Provides detailed reports of your browsing habits. | ||
- **Privacy Focused**: All data is stored locally, ensuring your privacy. | ||
- **Data Export**: Export your browsing data for further analysis or backup. | ||
|
||
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh | ||
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh | ||
## Installation | ||
|
||
## Expanding the ESLint configuration | ||
To install Open Browser Time, follow these steps: | ||
|
||
If you are developing a production application, we recommend updating the configuration to enable type aware lint rules: | ||
|
||
- Configure the top-level `parserOptions` property like this: | ||
|
||
```js | ||
export default tseslint.config({ | ||
languageOptions: { | ||
// other options... | ||
parserOptions: { | ||
project: ['./tsconfig.node.json', './tsconfig.app.json'], | ||
tsconfigRootDir: import.meta.dirname, | ||
}, | ||
}, | ||
}) | ||
``` | ||
|
||
- Replace `tseslint.configs.recommended` to `tseslint.configs.recommendedTypeChecked` or `tseslint.configs.strictTypeChecked` | ||
- Optionally add `...tseslint.configs.stylisticTypeChecked` | ||
- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and update the config: | ||
|
||
```js | ||
// eslint.config.js | ||
import react from 'eslint-plugin-react' | ||
|
||
export default tseslint.config({ | ||
// Set the react version | ||
settings: { react: { version: '18.3' } }, | ||
plugins: { | ||
// Add the react plugin | ||
react, | ||
}, | ||
rules: { | ||
// other rules... | ||
// Enable its recommended rules | ||
...react.configs.recommended.rules, | ||
...react.configs['jsx-runtime'].rules, | ||
}, | ||
}) | ||
``` | ||
1. Download the latest release from the [releases page](https://github.com/shfc/open-browser-time/releases). | ||
2. Extract the downloaded ZIP file. | ||
3. Open Chrome and navigate to `chrome://extensions/`. | ||
4. Enable "Developer mode" by toggling the switch in the top right corner. | ||
5. Click on "Load unpacked" and select the extracted folder. |