Skip to content

Commit

Permalink
Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Lukylix committed Jan 31, 2024
1 parent 03d6073 commit 275755d
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 10,993 deletions.
21 changes: 18 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,31 @@
# Chrolog - Your Open-Source Time Tracking Tool
# :rocket: Chrolog - Your Open-Source Time Tracking Tool

Chrolog is a time tracking software. It tracks time by recognizing keyboard and mouse actions, and records how long you spend on each project.
With the Chrome extension [Chrolog - TabTracker](https://chromewebstore.google.com/detail/chrolog-tabtracker/kcfeanjmngaljpdfnojiijemmfmdlapf) , you can choose which websites to exclude from tracking.

Visit the [release page](https://github.com/Lukylix/Chrolog/releases) to download binary files.

# Screenshots
# :desktop_computer: Screenshots

<img src="./ProjectDetails.png" alt="Project Details page" style="width: 300px;">
<img src="./Home.png" alt="Home page" style="width: 300px;">

# Development Guidelines
# :eyes: Privacy

- **Offline Usage**:
Chrolog tracks keyboard and mouse activity locally, ensuring that none of your data is transmitted or stored online.

- **No Parsing**:
Your inputs are tracked without content parsing, preserving the privacy of your keystrokes and mouse movements.

# :bug: Known Issues :

- ### Linux Tray Restoration :
- **Description:** The tray fails to restore when launched from a terminal on certain Linux distributions.
- **Resolution:** The issue is currently under investigation and seems to be related to Electron itself.
As a workaround, users can try launching the application directly using a graphical interface.

# :man_technologist: Development Guidelines

## Ideal IDE Setup

Expand Down
Loading

0 comments on commit 275755d

Please sign in to comment.