Skip to content

Commit 4d488d1

Browse files
authored
44 docs update main readmemd (#45)
### Description Update main README.md. Fixes #44
1 parent be9d046 commit 4d488d1

File tree

1 file changed

+32
-57
lines changed

1 file changed

+32
-57
lines changed

README.md

+32-57
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# Mql5-Python-Integration (MQPy)
2+
13
<p align="center">
24
<img src="docs/assets/logo.svg" alt="MQPy Logo" width="200" height="200">
35
</p>
@@ -9,84 +11,57 @@
911
<img src="https://img.shields.io/pypi/l/mqpy" alt="PyPI - License">
1012
</p>
1113

12-
<h1 align="center">Mql5-Python-Integration (MQPy)</h1>
13-
14-
<p align="center"><strong>Current Version: v0.6.9</strong></p>
15-
16-
Welcome to the Mql5-Python-Integration project! This project facilitates the integration between MetaTrader 5 (Mql5) and Python, allowing for efficient algorithmic trading strategies.
17-
18-
## ⚠️ TRADING RISK WARNING
14+
A Python library designed to simplify the process of creating Expert Advisors for MetaTrader 5. While developing directly in MQL5 can be complex, MQPy provides a more streamlined experience using Python.
1915

20-
**IMPORTANT: Trading involves substantial risk of loss and is not suitable for all investors.**
16+
## ⚠️ Important Notice
2117

22-
- Always use a **demo account** with fake money when testing strategies
23-
- MQPy is provided for **educational purposes only**
24-
- Past performance is not indicative of future results
18+
Trading involves risk. Always:
19+
- Use demo accounts for testing
2520
- Never trade with money you cannot afford to lose
26-
- The developers are not responsible for any financial losses incurred from using this software
27-
28-
## Table of Contents
29-
30-
- [⚠️ TRADING RISK WARNING](#️-trading-risk-warning)
31-
- [Table of Contents](#table-of-contents)
32-
- [Project Update: Changes in Progress](#project-update-changes-in-progress)
33-
- [Installation](#installation)
34-
- [Usage](#usage)
35-
- [Generate the File](#generate-the-file)
36-
- [Missing Features/Good Practice](#missing-featuresgood-practice)
37-
- [Delicate Metatrader5 Environment](#delicate-metatrader5-environment)
38-
- [Alternative Libraries](#alternative-libraries)
39-
40-
## Project Update: Changes in Progress
41-
42-
🚧 **Work in Progress: v0.6.9**
43-
This project is currently undergoing significant changes and improvements. The latest version is v0.6.0, and various enhancements are being made to provide a more robust and user-friendly experience.
44-
45-
📌 **Previous Version: v0.5.0**
46-
To access the code for the previous version, you can check it out at [v0.5.0](https://github.com/Joaopeuko/Mql5-Python-Integration/releases/tag/v0.5.0).
21+
- Understand that past performance doesn't guarantee future results
4722

4823
## Installation
4924

50-
**Note: In order to use this package, you need to have MetaTrader 5 installed on a Windows system with Python 3.8 or later.**
51-
52-
To install the package, you can use the following command:
53-
5425
```bash
5526
pip install mqpy
5627
```
5728

58-
Make sure to fulfill the prerequisites mentioned above before attempting to use the Mql5-Python-Integration (MQPy) package.
59-
60-
## Usage
29+
## Requirements
6130

62-
Basic Usage
31+
- Windows OS
32+
- Python 3.8 or later
33+
- MetaTrader 5 installed
6334

64-
Once installed, you can use the mqpy command to generate the boilerplate code.
35+
## Quick Start
6536

66-
### Generate the File
67-
68-
To create a template file for a trading strategy, use the following command:
37+
Generate a trading strategy template:
6938

7039
```bash
71-
mqpy --symbol <Symbol> --file_name <File Name>
40+
mqpy --symbol EURUSD --file_name my_strategy
7241
```
7342

74-
Please change `<Symbol>` and `<File Name>` to the desired values. For example:
75-
76-
```bash
77-
mqpy --symbol EURUSD --file_name demo
78-
```
43+
## Features
7944

80-
## Missing Features/Good Practice
45+
- Simple integration with MetaTrader 5
46+
- Easy-to-use command line interface
47+
- Basic template generation for trading strategies
48+
- Support for various trading strategies:
49+
- Moving Average Crossover
50+
- RSI-based trading
51+
- Bollinger Bands strategies
52+
- Fibonacci Retracement patterns
53+
- Multi-timeframe analysis
54+
- Custom indicator integration
8155

82-
This library has been in existence for several years and was designed to be simple and straightforward. While there are plans to enhance it with features such as logging and other components to improve its overall quality, there are considerations specific to the nature of the Metatrader5 library.
56+
## Documentation
8357

84-
### Delicate Metatrader5 Environment
58+
For detailed documentation, examples, and strategy explanations, visit:
59+
[https://joaopeuko.com/Mql5-Python-Integration/](https://joaopeuko.com/Mql5-Python-Integration/)
8560

86-
Metatrader5 operates within a highly restrictive environment, and certain practices that may be considered best practices in other contexts might cause trouble for newcomers in software development, which is the main focus of this library. For the sake of simplicity and ease of use, the library currently retains some practices that may not align with conventional best practices.
61+
## Support
8762

88-
### Alternative Libraries
63+
MQPy is a free and open-source project. If you'd like to support its development, consider becoming a sponsor.
8964

90-
For users seeking a more advanced library with a similar concept, consider exploring the following alternative:
65+
## License
9166

92-
[metatrader5EasyT](https://github.com/Joaopeuko/metatrader5EasyT): A more advanced library that aligns with best practices while providing a similar user-friendly approach. It is also available on PyPI.
67+
This project is licensed under the MIT License - see the LICENSE file for details.

0 commit comments

Comments
 (0)