Skip to content

Commit 0940246

Browse files
Update README.md
1 parent 7fc2345 commit 0940246

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,56 @@
1+
<!-- PROJECT SHIELDS -->
2+
[![Build Status][build-shield]]()
3+
[![Contributors][contributors-shield]]()
4+
[![MIT License][license-shield]][license-url]
5+
16
# Metaquotes MQL5 - Python Backtrader - API
27

38
### Development state: Alfa (Code not stable yet, documentation in development)
49

10+
<p align="left">
11+
[Report Bug](https://github.com/khramkov/MQL5-Backtrader-API/issues)
12+
·
13+
[Request Feature](https://github.com/khramkov/MQL5-Backtrader-API/issues)
14+
</p>
15+
16+
## Table of Contents
17+
* [About the Project](#about-the-project)
18+
* [Installation](#installation)
19+
* [Usage](#usage)
20+
* [License](#license)
21+
22+
## About The Project
23+
There are many great README templates available on GitHub, however, I didn't find one that really suit my needs so I created this enhanced one. I want to create a README template so amazing that it'll be the last one you ever need.
24+
25+
Here's why:
26+
* Your time should be focused on creating something amazing. A project that solves a problem and helps others
27+
* You shouldn't be doing the same tasks over and over like creating a README from scratch
28+
* You should element DRY principles to the rest of your life :smile:
29+
30+
Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue with the tag.
31+
32+
A list of commonly used resources that I find helpful are listed in the acknowledgements.
33+
34+
35+
## Installation
36+
1. Get a free API Key at [https://example.com](https://example.com)
37+
2. Clone the repo
38+
```sh
39+
git clone https:://github.com/your_username_/Project-Name.git
40+
```
41+
3. Install NPM packages
42+
```sh
43+
npm install
44+
```
45+
4. Enter your API in `config.js`
46+
```JS
47+
const API_KEY = 'ENTER YOUR API';
48+
```
49+
50+
## Usage
51+
Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
52+
53+
_For more examples, please refer to the [Documentation](https://example.com)_
54+
55+
## License
56+
Distributed under the MIT License. See `LICENSE` for more information.

0 commit comments

Comments
 (0)