docs: move installation to top

tolgaand · Mar 17, 2024 · dc39f47 · dc39f47
1 parent 63b2646
commit dc39f47
Show file tree

Hide file tree

Showing 2 changed files with 44 additions and 44 deletions.
diff --git a/README.md b/README.md
@@ -6,49 +6,6 @@ This SDK provides TypeScript developers with a simplified interface to interact
 
 This is a third-party SDK and not officially provided by Backpack Exchange.
 
-## Features
-
-- Market Data Access: Fetch prices, market statistics, and historical trades.
-- Account Management: Retrieve balances, deposit addresses, and withdrawal history.
-- Trading Operations: Execute orders, manage trades, and access order history.
-
-### Market APIs
-
-These are public endpoints that provide market data such as asset prices, market statistics, and historical trade data.
-
-| Function                | Description                            |
-| ----------------------- | -------------------------------------- |
-| `getAssets()`           | Retrieves all available assets.        |
-| `getMarkets()`          | Fetches supported market pairs.        |
-| `getTicker()`           | Gets ticker information for a symbol.  |
-| `getTickers()`          | Obtains tickers for all markets.       |
-| `getDepth()`            | Retrieves the depth of the order book. |
-| `getKlines()`           | Fetches K-line data for charting.      |
-| `getStatus()`           | Checks the exchange's system status.   |
-| `getPing()`             | Tests the API's connectivity.          |
-| `getSystemTime()`       | Gets the current system time.          |
-| `getRecentTrades()`     | Retrieves recent trades for a symbol.  |
-| `getHistoricalTrades()` | Fetches historical trades data.        |
-
-### Authenticated APIs
-
-These endpoints require authentication and are used for account-specific operations like trading, deposits, withdrawals, and account management.
-
-| Function              | Description                              |
-| --------------------- | ---------------------------------------- |
-| `getBalances()`       | Retrieves account balances.              |
-| `getDeposits()`       | Fetches deposit history.                 |
-| `getDepositAddress()` | Gets a deposit address for a blockchain. |
-| `getWithdrawals()`    | Retrieves withdrawal history.            |
-| `requestWithdrawal()` | Initiates a withdrawal.                  |
-| `getOrderHistory()`   | Fetches the history of orders.           |
-| `getFillHistory()`    | Retrieves historical fills.              |
-| `getOpenOrder()`      | Gets an open order.                      |
-| `cancelOrder()`       | Cancels an order.                        |
-| `executeOrder()`      | Executes a new order.                    |
-| `getOpenOrders()`     | Retrieves all open orders.               |
-| `cancelOpenOrders()`  | Cancels all open orders for a symbol.    |
-
 ## Authentication
 
 The SDK handles authenticated requests using ED25519 keypair signing, necessary for operations that mutate state.
@@ -99,3 +56,46 @@ async function main() {
 
 main();
 ```
+
+## Features
+
+- Market Data Access: Fetch prices, market statistics, and historical trades.
+- Account Management: Retrieve balances, deposit addresses, and withdrawal history.
+- Trading Operations: Execute orders, manage trades, and access order history.
+
+### Market APIs
+
+These are public endpoints that provide market data such as asset prices, market statistics, and historical trade data.
+
+| Function                | Description                            |
+| ----------------------- | -------------------------------------- |
+| `getAssets()`           | Retrieves all available assets.        |
+| `getMarkets()`          | Fetches supported market pairs.        |
+| `getTicker()`           | Gets ticker information for a symbol.  |
+| `getTickers()`          | Obtains tickers for all markets.       |
+| `getDepth()`            | Retrieves the depth of the order book. |
+| `getKlines()`           | Fetches K-line data for charting.      |
+| `getStatus()`           | Checks the exchange's system status.   |
+| `getPing()`             | Tests the API's connectivity.          |
+| `getSystemTime()`       | Gets the current system time.          |
+| `getRecentTrades()`     | Retrieves recent trades for a symbol.  |
+| `getHistoricalTrades()` | Fetches historical trades data.        |
+
+### Authenticated APIs
+
+These endpoints require authentication and are used for account-specific operations like trading, deposits, withdrawals, and account management.
+
+| Function              | Description                              |
+| --------------------- | ---------------------------------------- |
+| `getBalances()`       | Retrieves account balances.              |
+| `getDeposits()`       | Fetches deposit history.                 |
+| `getDepositAddress()` | Gets a deposit address for a blockchain. |
+| `getWithdrawals()`    | Retrieves withdrawal history.            |
+| `requestWithdrawal()` | Initiates a withdrawal.                  |
+| `getOrderHistory()`   | Fetches the history of orders.           |
+| `getFillHistory()`    | Retrieves historical fills.              |
+| `getOpenOrder()`      | Gets an open order.                      |
+| `cancelOrder()`       | Cancels an order.                        |
+| `executeOrder()`      | Executes a new order.                    |
+| `getOpenOrders()`     | Retrieves all open orders.               |
+| `cancelOpenOrders()`  | Cancels all open orders for a symbol.    |
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "backpack-market-sdk",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "A TypeScript SDK for interacting with the Backpack Exchange API.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",