From b7eed581cbe256f3b05b33ac9a2052a594722e01 Mon Sep 17 00:00:00 2001 From: Victor Giers Date: Sun, 1 Jun 2025 12:09:12 +0200 Subject: [PATCH] Update README.md with new project description and features --- README.md | 67 ++++++++++++++++++++++++++++++------------------------- 1 file changed, 37 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index d977199..37e3350 100644 --- a/README.md +++ b/README.md @@ -4,54 +4,61 @@ > ⚠️ **This README.md has been automatically generated using AI and might contain hallucinations or inaccuracies. Please proceed with caution!** -# Auto-Git - -**Author:** Victor Giers - -> ⚠️ **This README.md has been automatically generated using AI and might contain hallucinations or inaccuracies. Please proceed with caution!** +# Repo Monitor ## Description -Auto-Git: Git-Surveillance with automatic LLM-Commit-Message and README.md compilation. +Repo Monitor is a desktop application designed to help developers keep track of their Git repositories. It provides features such as monitoring repository activity, taking snapshots of commits, and managing multiple repositories efficiently. ## Features -- Monitors selected git repositories for changes. -- Automatically generates commit messages using a Large Language Model (LLM). -- Compiles and updates the `README.md` file based on the project's source code. + +- **Repository Monitoring**: Automatically monitors selected Git repositories for changes. +- **Snapshot Commits**: Save the state of a commit to a file for later reference. +- **Checkout Commits**: Switch between different commits in your repository. +- **Commit Diff Viewer**: View differences between commits directly within the application. +- **Multiple Repositories**: Manage and switch between multiple Git repositories easily. +- **Tray Integration**: Access quick actions via system tray menu. +- **Cat Assistant**: An interactive cat assistant that provides feedback based on commit activity. ## Installation -1. Clone the repository: - ```bash - git clone https://github.com/victorgiers/auto-git.git - cd auto-git - - -2. Install dependencies: - ```bash - npm install - - -3. Start the application: - ```bash - npm start - +1. Download the latest release from the [Releases](https://github.com/yourusername/repo-monitor/releases) page. +2. Extract the downloaded archive. +3. Run the application executable (`RepoMonitor.exe` for Windows, `RepoMonitor.app` for macOS, or `RepoMonitor` for Linux). ## Usage -1. Open the application. -2. Add your git repositories to be monitored. -3. Configure settings such as LLM model and author details. -4. Let Auto-Git handle commit messages and README compilation. +1. **Add a Repository**: Click the "Add Folder" button to add a Git repository to be monitored. +2. **Select a Repository**: Click on a repository in the sidebar to view its commits. +3. **View Commits**: Navigate through commits using pagination and view commit details, including diffs. +4. **Take Snapshots**: Use the snapshot button to save the state of a specific commit. +5. **Checkout Commits**: Switch to a different commit by clicking the checkout button. + +## Contributing + +Contributions are welcome! Please read the [CONTRIBUTING.md](CONTRIBUTING.md) file for guidelines on how to contribute to the project. ## License -This project is licensed under the MIT License. +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. + +## Contact + +For any questions or support, please contact us at [support@repomonitor.com](mailto:support@repomonitor.com). + +--- + +**Repo Monitor** +*Effortlessly manage your Git repositories.* + +![Cat Assistant](assets/cat/assistant.png) + +--- MIT License -Copyright (c) 2023 Victor Giers +Copyright (c) 2023 Your Name Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal