add readme file

README.md

@@ -0,0 +1,122 @@
+# Maven Repository Mirroring and Caching Tool
+
+This repository provides a solution for mirroring and caching multiple Maven repositories, offering a unified endpoint.This endpoint can then be utilized in `gradle.build` files to streamline your Gradle-based projects.
+
+## Table of Contents
+
+- [Introduction](#introduction)
+- [Features](#features)
+- [Getting Started](#getting-started)
+  - [Prerequisites](#prerequisites)
+  - [Installation](#installation)
+  - [Configuration](#configuration)
+- [Usage](#usage)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Introduction
+
+Managing multiple Maven repositories can become cumbersome, especially when dealing with Gradle projects. This project aims to simplify the process by creating a unified endpoint that mirrors and caches the artifacts from various Maven repositories. This can lead to reduced build times and improved overall development efficiency.
+
+## Features
+
+- **Unified Endpoint**: Access all your Maven dependencies through a single, local endpoint.
+- **Caching**: Store downloaded artifacts locally to minimize redundant network requests.
+- **Mirroring**: Mirror remote Maven repositories for offline development and increased reliability.
+- **Customization**: Configure the tool to handle specific repositories and dependencies.
+
+## Getting Started
+
+### Prerequisites
+
+Before you begin, ensure you have the following prerequisites:
+
+- [Node.js](https://nodejs.org/) installed.
+- [Yarn](https://classic.yarnpkg.com/en/docs/install/) installed.
+
+### Installation
+
+Follow these steps to set up the Maven repository mirroring and caching project:
+
+1. Clone the repository:
+
+   ```bash
+   git clone https://github.com/hexboy/maven-mirror-tool.git
+   cd maven-mirror-tool
+   ```
+
+2. Install dependencies using Yarn:
+
+   ```bash
+   yarn install
+   ```
+
+### Configuration
+
+1. Duplicate the `config.yml` file and rename it to `config.local.yml` in the project root directory.
+2. Open the `config.local.yml` file.
+3. Customize the `REPOSITORIES` array to include the Maven repositories you want to mirror and cache.
+4. Modify any other settings as needed, such as port number or caching options or proxy servers.
+
+Here's an example configuration snippet:
+
+```yaml
+PROXIES:
+  fodev: # this key is used in `proxy` section in repository config.
+    host: fodev.org
+    port: 8118
+    protocol: http # protocol can be  "http" or "https" or "socks5".
+
+  local:
+    host: 127.0.0.1
+    port: 1080
+    protocol: socks5
+
+REPOSITORIES:
+  - name: central
+    url: https://repo1.maven.org/maven2
+    fileTypes:   # optional: you can specified fileTypes to cache.
+      - '.jar'   #
+      - '.aar'   #
+    proxy: fodev # optional: select a proxy server
+
+  - name: private-repo
+    url: https://repo.mycompany.com/maven
+    auth:                  # optional: authentication info
+      username: myusername #
+      password: mypassword #
+```
+
+## Usage
+
+1. Start the Maven Repository Mirroring and Caching Tool:
+
+   ```bash
+   yarn start
+   ```
+
+2. Update your Gradle `build.gradle` files to use the local endpoint for Maven dependencies:
+
+   ```gradle
+   repositories {
+       mavenLocal();
+       // add local mirror server after mavenLocal()
+       maven {
+           url 'http://127.0.0.1:8008/v1' // Replace with your configured port
+       }
+   }
+   ```
+
+3. Run your Gradle builds as usual. The tool will intercept and resolve dependencies from the local endpoint, caching them if needed.
+
+## Contributing
+
+Contributions are welcome! If you find any issues or would like to enhance the project, feel free to submit a pull request. Please follow the existing code style and provide clear commit messages.
+
+## License
+
+This project is licensed under the [MIT License](LICENSE), allowing you to use, modify, and distribute the code freely. Make sure to read and understand the license terms before using the project.
+
+---
+
+By following this README, you should be able to set up and use the Maven Repository Mirroring and Caching Tool for your Gradle projects seamlessly. If you encounter any issues or have further questions, don't hesitate to reach out to the project contributors.