diff --git a/README.md b/README.md index dd99312..b6cfdd0 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,16 @@ # pyokx [![Downloads](https://pepy.tech/badge/pyokx)](https://pepy.tech/project/pyokx) ![Tests](https://github.com/nicelgueta/pyokx/actions/workflows/pyokx.yml/badge.svg) + + +## ====== ARCHIVED ======= + +This repo is being archived as it is no longer maintained. Since this library was first created, OKX have released their [own python SDK](https://github.com/okxapi/python-okx) that is far more complete than this and is actively maintained, which makes it a better option than `pyokx`. + +===== + +_________________ + ## Installation ```shell @@ -126,4 +136,4 @@ api_response = account.get_positions(use_proxy=True) - [ ] Websocket API implementation. ## Disclaimer -> NB. pyokx is totally unofficial and is in no way affiliated with OKEX Crypto exchange and simply exists as a helpful wrapper to interact with the V5 API. \ No newline at end of file +> NB. pyokx is totally unofficial and is in no way affiliated with OKEX Crypto exchange and simply exists as a helpful wrapper to interact with the V5 API.