Repo Activity Recorder 📊

Welcome to Repo Activity Recorder, a tool designed to automatically track and visualize your GitHub repository activity and contribution data. This tool provides dynamic SVG displays of your GitHub statistics, making it easier for you to monitor your progress and contributions over time.

Table of Contents

1. Features
2. Getting Started
3. How It Works
4. Usage
5. Configuration
6. Contributing
7. License
8. Contact
9. Releases

Features

• Automated Tracking: Automatically records daily activity and contribution data for your GitHub repositories.
• Dynamic Visualization: Displays your activity and contribution data as SVG images.
• Profile Integration: Shows total stars, clones, and views for each repository on your GitHub profile.
• No Time Limits: Records total stars, clones, and views without a 14-day limit.
• Easy Setup: Simple workflow to start tracking your repository activity.

Getting Started

To get started with Repo Activity Recorder, you can download the latest release from here. After downloading, follow the instructions below to set up the tool.

Prerequisites

Before you begin, ensure you have the following installed:

• Python 3.x
• GitHub account

How It Works

Repo Activity Recorder utilizes GitHub Actions to run workflows that gather statistics about your repositories. It collects data on stars, clones, and views, and visualizes this information in an easy-to-read format.

Data Collection

The tool uses GitHub's API to gather the necessary data. It runs daily to ensure that your statistics are up-to-date.

Visualization

The collected data is then transformed into SVG images. These images can be displayed on your GitHub profile, providing a visual representation of your contributions.

Usage

After setting up the tool, you can begin using it to track your GitHub activity.

1. Run the Workflow: Start by manually running the “Generate Stats Images” workflow in the Actions tab of your repository.
2. View Your Stats: Once the workflow completes, you can view your stats on your profile and within the repository.

Configuration

You may want to customize certain settings to fit your needs. Here’s how to do it:

Setting Up Your GitHub Token

1. Go to your GitHub account settings.
2. Navigate to Developer settings > Personal access tokens.
3. Generate a new token with the necessary permissions.
4. Store this token securely and use it in your configuration.

Configuring Repository Settings

You can configure which repositories to track by editing the configuration file. Specify the repositories you want to include in the tracking process.

Contributing

Contributions are welcome! If you want to help improve Repo Activity Recorder, follow these steps:

1. Fork the repository.
2. Create a new branch (git checkout -b feature-branch).
3. Make your changes.
4. Commit your changes (git commit -m 'Add new feature').
5. Push to the branch (git push origin feature-branch).
6. Open a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contact

For questions or suggestions, feel free to reach out:

• GitHub: Shravancoder2022
• Email: your-email@example.com

Releases

To download the latest version of Repo Activity Recorder, visit the Releases section. Download the appropriate file, execute it, and start tracking your GitHub activity today!

Conclusion

Repo Activity Recorder provides a straightforward way to monitor your GitHub contributions. With automated tracking and dynamic visualizations, you can stay informed about your progress. Whether you are a seasoned developer or just starting, this tool can help you visualize your contributions effectively.

Thank you for checking out Repo Activity Recorder! We hope you find it useful in your GitHub journey.