Skip to content

Commit e6758ea

Browse files
committed
Updated the readme
1 parent 89ea53f commit e6758ea

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,12 @@ Variable types are set on all function parameters.
1818

1919
If you are using version 0.4.0, see the branch `trader-0.4.0` for that.
2020

21+
## Purpose
22+
23+
This package is meant to help when using the Trader PECL package.
24+
This is helpful if you do not have the code stub for the Trader Extension.
25+
Loading this interface will provide your IDE with the function information and auto completing.
26+
2127
## How to use
2228

2329
Lets assume that you want to generate a correlation indicator.
@@ -28,8 +34,6 @@ You can now use the exact named
2834
or the friendly named
2935
`\LupeCode\phpTraderInterface\Trader::pearsonCorrelationCoefficient($Open, $Close, 30)`
3036

31-
This is helpful if you do not have the code stub for the Trader Extension. Loading this interface will provide your IDE with the function information and auto completing.
32-
3337
## Metrics & Coverage
3438
### PHP Metrics Report
3539
To see the current report of metrics by PHP Metrics, visit [Metrics](https://projects.lupecode.com/phpTraderInterface/metrics/)
@@ -44,7 +48,7 @@ To see the current report of coverage by PHP Unit, visit [Coverage](https://proj
4448
* PHP 7.2 TS [[XML]](https://projects.lupecode.com/phpTraderInterface/logs/logfile-7.2TS.xml) [[TXT]](https://projects.lupecode.com/phpTraderInterface/logs/testdox-7.2TS.txt) [[HTML]](https://projects.lupecode.com/phpTraderInterface/logs/testdox-7.2TS.html)
4549

4650
## License
47-
Copyright (C) Lupe Code, LLC.; Joshua Saige
51+
Copyright (C) Lupe Code, LLC.; Joshua Lopez
4852

4953
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
5054

0 commit comments

Comments
 (0)