diff --git a/README.md b/README.md new file mode 100644 index 0000000..2c12400 --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +# DCAv2GUI + +dcaV2GUI is a user-friendly graphical user interface (GUI) application designed to use in conjunction with the DCAv2 project. + +## Features + +- **Multiple Exchange Support**: Currently supports Binance, Gate.io, Kucoin, and OKX. More exchanges will be added in future updates. +- **Live Data Monitoring**: Displays real-time market data and portfolio performance. +- **Settings Management**: Provides dedicated menus for managing user credentials and preferences. + +## Project Structure + +The project is structured using the Model-View-ViewModel (MVVM) architecture, leveraging Android's Jetpack components for efficient development and maintenance. + +## Usage + +1. **Clone the Repository**: + ```bash + git clone https://gitlab.nicosanchez.com.ar/nicolas/dcav2gui.git + ``` + +2. **Open in Android Studio**: Import the project into Android Studio for further development or testing. + +3. **Build and Run**: Use Android Studio to build the application and run it on an emulator or a physical device. + +## Future Enhancements + +- **Configurable Settings**: Replace hardcoded sections with user-configurable settings. +- **Additional Exchanges**: Integrate support for more cryptocurrency exchanges. + +--- + +**Note:** This project is a work in progress, and some features are subject to change.