Skip to content

Commit

Permalink
style(readme): add logo + html in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
cimourdain committed Nov 12, 2020
1 parent 5abf222 commit 1d0b60d
Show file tree
Hide file tree
Showing 5 changed files with 73 additions and 34 deletions.
3 changes: 2 additions & 1 deletion MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
prune tests
prune docs
prune samples
prune scripts
prune scripts
prune assets
51 changes: 34 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,37 @@
# Estrade


[![Build Status](https://travis-ci.com/cimourdain/estrade.svg?branch=0.2a1)](https://travis-ci.com/cimourdain/estrade)
[![Documentation Status](https://readthedocs.org/projects/estrade/badge/?version=0.2a1)](https://estrade.readthedocs.io/en/0.2a1/?badge=0.2a1)
![python](https://badgen.net/badge/python/3.6,3.7,3.8?list=|)
![version](https://badgen.net/badge/version/0.2a1)
[![pypi](https://badgen.net/pypi/v/estrade)](https://pypi.org/project/estrade/)
![coverage](https://badgen.net/badge/coverage/95%25)
![complexity](https://badgen.net/badge/complexity/A%20%281.8807339449541285%29)
[![flake8](https://badgen.net/badge/lint/flake8/purple)](https://gitlab.com/pycqa/flake8)
[![black](https://badgen.net/badge/code%20style/black/000)](https://github.com/ambv/black)
[![mypy](https://badgen.net/badge/static%20typing/mypy/pink)](https://github.com/python/mypy)
![licence](https://badgen.net/badge/licence/GNU-GPL3)


# Estrade: Trading bot manager
<h1 align="center">
<a href="https://github.com/cimourdain/estrade"><img src="assets/logo.png" alt="Estrade" width="399"/></a><br>
<a href="https://github.com/cimourdain/estrade">Estrade</a>
</h1>


<div align="center">
<a href="https://travis-ci.com/cimourdain/estrade">
<img src="https://travis-ci.com/cimourdain/estrade.svg?branch=0.2a1" alt="Build Status" />
</a>
<a href='https://estrade.readthedocs.io/en/latest/?badge=0.2a1'>
<img src='https://readthedocs.org/projects/estrade/badge/?version=0.2a1' alt='Documentation Status' />
</a>
<img src="https://badgen.net/badge/python/3.6,3.7,3.8?list=|" alt="python version" />
<img src="https://badgen.net/badge/version/0.2a1" alt="current app version" />
<a href="https://pypi.org/project/estrade/">
<img src="https://badgen.net/pypi/v/estrade" alt="PyPi version" />
</a>
<img src="https://badgen.net/badge/coverage/95%25" alt="Coverage" />
<img src="https://badgen.net/badge/complexity/A%20%281.8807339449541285%29" alt="Complexity" />
<a href="https://gitlab.com/pycqa/flake8">
<img src="https://badgen.net/badge/lint/flake8/purple" alt="Lint" />
</a>
<a href="https://github.com/ambv/black">
<img src="https://badgen.net/badge/code%20style/black/000" alt="Code format" />
</a>
<a href="https://github.com/python/mypy">
<img src="https://badgen.net/badge/static%20typing/mypy/pink" alt="Typing" />
</a>
<img src="https://badgen.net/badge/licence/GNU-GPL3" alt="Licence" />
</div>


# Backtest and run your trading strategies

Estrade is a python library that allows you to easily backtest and run stock trading strategies at tick level.

Expand Down
45 changes: 31 additions & 14 deletions README.template
Original file line number Diff line number Diff line change
@@ -1,20 +1,37 @@
# Estrade
{% if include_badges %}
<h1 align="center">
<a href="https://github.com/cimourdain/estrade"><img src="assets/logo.png" alt="Estrade" width="399"/></a><br>
<a href="https://github.com/cimourdain/estrade">Estrade</a>
</h1>

[![Build Status](https://travis-ci.com/cimourdain/estrade.svg?branch={{git_branch}})](https://travis-ci.com/cimourdain/estrade)
[![Documentation Status](https://readthedocs.org/projects/estrade/badge/?version={{readthedocs_version}})](https://estrade.readthedocs.io/en/{{readthedocs_version}}/?badge={{readthedocs_version}})
![python](https://badgen.net/badge/python/3.6,3.7,3.8?list=|)
![version](https://badgen.net/badge/version/{{version}})
[![pypi](https://badgen.net/pypi/v/estrade)](https://pypi.org/project/estrade/)
![coverage](https://badgen.net/badge/coverage/{{coverage_pct | urlencode}})
![complexity](https://badgen.net/badge/complexity/{{complexity | urlencode}})
[![flake8](https://badgen.net/badge/lint/flake8/purple)](https://gitlab.com/pycqa/flake8)
[![black](https://badgen.net/badge/code%20style/black/000)](https://github.com/ambv/black)
[![mypy](https://badgen.net/badge/static%20typing/mypy/pink)](https://github.com/python/mypy)
![licence](https://badgen.net/badge/licence/GNU-GPL3)
{% if include_badges %}
<div align="center">
<a href="https://travis-ci.com/cimourdain/estrade">
<img src="https://travis-ci.com/cimourdain/estrade.svg?branch={{git_branch}}" alt="Build Status" />
</a>
<a href='https://estrade.readthedocs.io/en/latest/?badge={{readthedocs_version}}'>
<img src='https://readthedocs.org/projects/estrade/badge/?version={{readthedocs_version}}' alt='Documentation Status' />
</a>
<img src="https://badgen.net/badge/python/3.6,3.7,3.8?list=|" alt="python version" />
<img src="https://badgen.net/badge/version/{{version}}" alt="current app version" />
<a href="https://pypi.org/project/{{app_name}}/">
<img src="https://badgen.net/pypi/v/{{app_name}}" alt="PyPi version" />
</a>
<img src="https://badgen.net/badge/coverage/{{coverage_pct | urlencode}}" alt="Coverage" />
<img src="https://badgen.net/badge/complexity/{{complexity | urlencode}}" alt="Complexity" />
<a href="https://gitlab.com/pycqa/flake8">
<img src="https://badgen.net/badge/lint/flake8/purple" alt="Lint" />
</a>
<a href="https://github.com/ambv/black">
<img src="https://badgen.net/badge/code%20style/black/000" alt="Code format" />
</a>
<a href="https://github.com/python/mypy">
<img src="https://badgen.net/badge/static%20typing/mypy/pink" alt="Typing" />
</a>
<img src="https://badgen.net/badge/licence/GNU-GPL3" alt="Licence" />
</div>
{% endif %}

# Estrade: Trading bot manager
# Backtest and run your trading strategies

Estrade is a python library that allows you to easily backtest and run stock trading strategies at tick level.

Expand Down
Binary file added assets/logo.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 6 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
# Estrade
<h1 align="center">
<a href="https://github.com/cimourdain/estrade"><img src="assets/logo.png" alt="Estrade" width="399"/></a><br>
<a href="https://github.com/cimourdain/estrade">Estrade</a>
</h1>


# Estrade: Trading bot manager

# Backtest and run your trading strategies

Estrade is a python library that allows you to easily backtest and run stock trading strategies at tick level.

Expand Down

0 comments on commit 1d0b60d

Please sign in to comment.