diff --git a/README.md b/README.md index 6f391a3..6b5e160 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,66 @@ -# bybit.go.api -Bybit Official Open API SDK +# bybit-go-api +[![GO 1.21.0](https://img.shields.io/badge/Go-1.21.0-brightgreen.svg)](https://github.com/wuhewuhe/bybit-go-api) [![Contributor Victor](https://img.shields.io/badge/contributor-Victor-blue.svg)](https://github.com/wuhewuhe/bybit-go-api) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/wuhewuhe/bybit-go-api/blob/main/LICENSE) +## Table of Contents +- [About](#about) +- [Development](#development) +- [Installation](#installation) +- [Usage](#usage) +- [Contact](#contact) +- [Contributors](#contributors) +- [Donations](#donations) +## About +The Official Go Lang API connector for Bybit's HTTP and WebSocket APIs. + +Dive into a plethora of functionalities: +- Market Data Retrieval +- Trade Execution +- Position Management +- Account and Asset Info Retrieval +- User and Upgrade Management +- Public Websocket Streaming +- Private Websocket Streaming +- Lending Institution and Client +- Broker Earning Data + +bybit-go-api provides an official, robust, and high-performance go connector to Bybit's trading APIs. + +Initially conceptualized by esteemed go developer Victor, this module is now maintained by Bybit's in-house go experts. + +Your contributions are most welcome! + +## Development +bybit-go-api is under active development with the latest features and updates from Bybit's API implemented promptly. The module utilizes minimal external libraries to provide a lightweight and efficient experience. If you've made enhancements or fixed bugs, please submit a pull request. + +## Installation +Ensure you have go 1.21.0 or higher. You can include bybit-go-api in your project using Maven or Gradle. + +## Usage +Note: Replace placeholders (like YOUR_API_KEY, links, or other details) with the actual information. You can also customize this template to better fit the actual state and details of your Java API. +### Rest API +### Websocket public channel +### Websocket private channel + +## Contact +For support, join our Bybit API community on [Telegram](https://t.me/Bybitapi). + +## Contributors +List of other contributors + + + + +
+ + +
+ + Victor + +
+
+ 💻 + 📖 +
+ +## Donations +Your donations keep our development active and our community growing. Donate USDT to our [ERC20 Wallet Address](0x238bbb45af1254e2fd76564c9b56042c452f3d6e). \ No newline at end of file