Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
oliver-zehentleitner committed May 14, 2024
1 parent bbc91e7 commit a8079cd
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,8 @@ combination.
- Helpful management features like
[`get_used_weight()`](https://unicorn-binance-rest-api.docs.lucit.tech/unicorn_binance_rest_api.html#unicorn_binance_rest_api.manager.BinanceRestApiManager.get_used_weight),

- Available via `pip` and `conda` as precompiled C-Extention including stub files for improved Intellisense features and
source code easier debugging.

- Integration of [test cases](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/actions/workflows/unit-tests.yml) and [examples](#examples).

Expand All @@ -175,7 +177,7 @@ If you like the project, please [![star](https://raw.githubusercontent.com/lucit
The module requires Python 3.7 or above, as it depends on Pythons latest asyncio features for asynchronous/concurrent
processing.

For Anaconda we offer packages only from Python version 3.8 and higher.
For Anaconda, we offer packages only from Python version 3.8 and higher.

For the PyPy interpreter we offer packages only from Python version 3.9 and higher.

Expand Down Expand Up @@ -239,7 +241,7 @@ conda install -c lucit unicorn-binance-rest-api
#### Update
`conda update -c lucit unicorn-binance-rest-api`

### From source of the latest release with PIP from [Github](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api)
### From source of the latest release with PIP from [GitHub](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api)
#### Linux, macOS, ...
Run in bash:

Expand All @@ -251,7 +253,7 @@ Use the below command with the version (such as 2.5.1) you determined

`pip install https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/archive/2.5.1.tar.gz --upgrade`

### From the latest source (dev-stage) with PIP from [Github](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api)
### From the latest source (dev-stage) with PIP from [GitHub](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api)
This is not a release version and can not be considered to be stable!

`pip install https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/tarball/master --upgrade`
Expand Down Expand Up @@ -325,7 +327,7 @@ click ![thumbs-up](https://raw.githubusercontent.com/lucit-systems-and-developme
Before you report a bug, [try the latest release](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api#installation-and-upgrade). If the issue still exists, provide the error trace, OS
and Python version and explain how to reproduce the error. A demo script is appreciated.

If you dont find an issue related to your topic, please open a new [issue](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/issues)!
If you don't find an issue related to your topic, please open a new [issue](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/issues)!

[Report a security bug!](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/security/policy)

Expand Down Expand Up @@ -357,7 +359,7 @@ We would like to explicitly point out that in our opinion US citizens are exclus
and that this restriction must not be circumvented!

The purpose of supporting a SOCKS5 proxy in the UNICORN Binance Suite and its modules is to allow non-US citizens to use
US services. For example, Github actions with UBS will not work without a SOCKS5 proxy, as they will inevitably run on
US services. For example, GitHub actions with UBS will not work without a SOCKS5 proxy, as they will inevitably run on
servers in the US and be blocked by Binance.com. Moreover, it also seems justified that traders, data scientists and
companies from the US analyze binance.com market data - as long as they do not trade there.

Expand Down

0 comments on commit a8079cd

Please sign in to comment.