aljaz/bitfinex-api-py
1
0
Fork 0
mirror of https://github.com/aljazceru/bitfinex-api-py.git synced 2025-12-18 06:14:22 +01:00
Code Issues Packages Projects Releases Wiki Activity

Remove all references to beta versions in README.md.

Browse Source
This commit is contained in:
Davide Casale
2024-04-04 16:43:43 +02:00
parent 65318beee9
commit 089e193780
1 changed files with 3 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@@ -1,12 +1,7 @@
# bitfinex-api-py (v3-beta)
# bitfinex-api-py
Official implementation of the [Bitfinex APIs (V2)](https://docs.bitfinex.com/docs) for `Python 3.8+`.
> **DISCLAIMER:** \
Production use of v3.0.0b1 (and all future beta versions) is HIGHLY discouraged. \
Beta versions should not be used in applications which require user authentication. \
Provide your API-KEY/API-SECRET, and manage your account and funds at your own risk.
### Features
* Support for 75+ REST endpoints (a list of available endpoints can be found [here](https://docs.bitfinex.com/reference))
@@ -20,13 +15,6 @@ Provide your API-KEY/API-SECRET, and manage your account and funds at your own r
python3 -m pip install --pre bitfinex-api-py
```
### Selecting and installing a specific beta version
It's also possible to select and install a specific beta version:
```console
python3 -m pip install bitfinex-api-py==3.0.0b1
```
---
# Quickstart
@@ -305,7 +293,7 @@ All contributions are welcome! :D
A guide on how to install and set up `bitfinex-api-py`'s source code can be found [here](#installation-and-setup). \
Before opening any pull requests, please have a look at [Before Opening a PR](#before-opening-a-pr). \
Contributors must uphold the [Contributor Covenant code of conduct](https://github.com/bitfinexcom/bitfinex-api-py/blob/v3-beta/CODE_OF_CONDUCT.md).
Contributors must uphold the [Contributor Covenant code of conduct](https://github.com/bitfinexcom/bitfinex-api-py/blob/master/CODE_OF_CONDUCT.md).
### Index
@@ -323,10 +311,8 @@ A brief guide on how to install and set up the project in your Python 3.8+ envir
### Cloning the repository
The following command will only clone the `v3-beta` branch (excluding all others):
```console
git clone --branch v3-beta --single-branch https://github.com/bitfinexcom/bitfinex-api-py.git
git clone https://github.com/bitfinexcom/bitfinex-api-py.git
```
### Installing the dependencies