diff --git a/README.md b/README.md index e283be7..17879de 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# web-activity-tracker +# Web Activity Tracker (BroTime) -This is a simple web activity tracker Chrome extension that can be used to track user activity on websites. It is built with Typescript, React, ShadcnUI + Tailwind and uses Chrome extension manifest V3. +A comprehensive web activity tracker Chrome extension built with TypeScript, React, ShadcnUI, and Tailwind. This extension leverages Chrome extension manifest V3 to provide detailed insights into user activity on websites. Screenshot 2022-12-04 at 16 18 20 @@ -10,32 +10,33 @@ This is a simple web activity tracker Chrome extension that can be used to track ## Privacy -Extension does not share collected data from the user. It stores data locally on the user's machine. +This extension prioritizes user privacy by ensuring that all collected data is stored locally on the user's machine. -- Data is stored in the browser's storage ([chrome.storage](https://developer.chrome.com/docs/apps/manifest/storage/), [IndexedDB](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API)) -- Data is not shared with third-party services or servers -- Data is only used to display activity statistics to the user +- Data is stored using the browser's storage mechanisms ([chrome.storage](https://developer.chrome.com/docs/apps/manifest/storage/), [IndexedDB](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API)). +- No data is shared with third-party services or servers. +- Collected data is solely used to display activity statistics to the user. ## Features -- Tracks activity on websites as well as local files (PDFs). -- Supports activity tracking on audible websites with idle behavior (like Youtube, Netflix, Spotify, Discord) without extra permissions -- Displays total activity on every website on a specific date or week with a second precision. -- Minute by minute activity timeline for a specific website or all websites on a specific date or week. -- Overall activity heat calendar -- Graph of top 5 active websites. -- Compares daily activity with current week average. +- Tracks activity on websites and local files (e.g., PDFs). +- Supports activity tracking on audible websites with idle behavior (e.g., YouTube, Netflix, Spotify, Discord) without requiring extra permissions. +- Displays total activity on each website for a specific date or week with second-level precision. +- Provides a minute-by-minute activity timeline for specific websites or all websites on a given date or week. +- Includes an overall activity heat calendar. +- Features a graph of the top 5 active websites. +- Compares daily activity with the current week's average. ## Development -Install [nvm](https://github.com/nvm-sh/nvm) +To set up the development environment, follow these steps: -Clone the repository and run the following commands: +1. Install [nvm](https://github.com/nvm-sh/nvm). +2. Clone the repository. +3. Run the following commands: ```bash nvm install nvm use - npm install npm start ```