Skip to content

Commit b1f70dd

Browse files
committed
docs: Improve README information
1 parent e0fd27d commit b1f70dd

File tree

1 file changed

+25
-10
lines changed

1 file changed

+25
-10
lines changed

README.md

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,24 @@
1-
# Mql5-Python-Integration
2-
31
![PyPI - Downloads](https://img.shields.io/pypi/dm/mqpy)
42
![PyPI](https://img.shields.io/pypi/v/mqpy)
53
![PyPI - Wheel](https://img.shields.io/pypi/wheel/mqpy)
64
![PyPI - License](https://img.shields.io/pypi/l/mqpy)
75

8-
## Project Overview
6+
# Mql5-Python-Integration
97

108
**Current Version: v0.6.0**
119

1210
Welcome to the Mql5-Python-Integration project! This project facilitates the integration between MetaTrader 5 (Mql5) and Python, allowing for efficient algorithmic trading strategies.
1311

12+
## Table of Contents
13+
14+
- [Mql5-Python-Integration](#mql5-python-integration)
15+
- [Table of Contents](#table-of-contents)
16+
- [Project Update: Changes in Progress](#project-update-changes-in-progress)
17+
- [Installation](#installation)
18+
- [Missing Features/Good Practice](#missing-featuresgood-practice)
19+
- [Delicate Metatrader5 Environment](#delicate-metatrader5-environment)
20+
- [Alternative Libraries](#alternative-libraries)
21+
1422
## Project Update: Changes in Progress
1523

1624
🚧 **Work in Progress: v0.6.0**
@@ -19,13 +27,6 @@ This project is currently undergoing significant changes and improvements. The l
1927
📌 **Previous Version: v0.5.0**
2028
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).
2129

22-
## Table of Contents
23-
24-
- [Mql5-Python-Integration](#mql5-python-integration)
25-
- [Project Update: Changes in Progress](#project-update-changes-in-progress)
26-
- [Table of Contents](#table-of-contents)
27-
- [Installation](#installation)
28-
2930
## Installation
3031

3132
**Note: In order to use this package, you need to have MetaTrader 5 installed on a Windows system with Python 3.8 or later.**
@@ -37,3 +38,17 @@ pip install mqpy
3738
```
3839

3940
Make sure to fulfill the prerequisites mentioned above before attempting to use the Mql5-Python-Integration (MQPy) package.
41+
42+
## Missing Features/Good Practice
43+
44+
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.
45+
46+
### Delicate Metatrader5 Environment
47+
48+
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.
49+
50+
### Alternative Libraries
51+
52+
For users seeking a more advanced library with a similar concept, consider exploring the following alternative:
53+
54+
[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.

0 commit comments

Comments
 (0)