Update README.md

Pulled from jup-ag#1

Author: abunsen

README.md

@@ -1,10 +1,83 @@
-# Jupiter api rust example
+# jup-swap-api-client
 
-We can autogenerate a client with openapi-gen and the openapi schema but the structs cannot be directly consumed as solana sdk or appropirate rust types.
+## Introduction
 
-The crate `jupiter-swap-api` exposes the API types to allow
+The `jup-swap-api-client` is a Rust client library designed to simplify the integration of the Jupiter Swap API, enabling seamless swaps on the Solana blockchain.
 
-If you must use solana 1.16 crates, there is a work in progress to relax tokio pinned too low conflicting with many other crates https://github.com/solana-labs/solana/pull/32943
+### What is jup.ag?
+
+[jup.ag](https://jup.ag/) is a powerful platform that provides developers with an easy way to access liquidity on the Solana blockchain. It simplifies the process of executing swaps by allowing you to specify the desired token pairs, amount, and slippage. In return, the API will provide you with the serialized transactions required to execute the swap on the Solana blockchain, complete with the necessary signatures.
+
+## Getting Started
+
+To use the `jup-swap-api-client` crate in your Rust project, follow these simple steps:
+
+Add the crate to your `Cargo.toml`:
+
+    ```toml
+    [dependencies]
+    jup-swap-api-client = "0.1.0"
+    ```
+
+## Examples
+
+Here's a simplified example of how to use the `jup-swap-api-client` in your Rust application:
+
+```rust
+use jupiter_swap_api_client::{
+    quote::QuoteRequest, swap::SwapRequest, transaction_config::TransactionConfig,
+    JupiterSwapApiClient,
+};
+use solana_sdk::pubkey::Pubkey;
+
+const USDC_MINT: Pubkey = pubkey!("EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v");
+const NATIVE_MINT: Pubkey = pubkey!("So11111111111111111111111111111111111111112");
+const TEST_WALLET: Pubkey = pubkey!("2AQdpHJ2JpcEgPiATUXjQxA8QmafFegfQwSLWSprPicm");
+
+#[tokio::main]
+async fn main() {
+    let jupiter_swap_api_client = JupiterSwapApiClient::new("https://quote-api.jup.ag/v6");
+
+    let quote_request = QuoteRequest {
+        amount: 1_000_000,
+        input_mint: USDC_MINT,
+        output_mint: NATIVE_MINT,
+        slippage_bps: 50,
+        ..QuoteRequest::default()
+    };
+
+    // GET /quote
+    let quote_response = jupiter_swap_api_client.quote(&quote_request).await.unwrap();
+    println!("{quote_response:#?}");
+
+    // POST /swap
+    let swap_response = jupiter_swap_api_client
+        .swap(&SwapRequest {
+            user_public_key: TEST_WALLET,
+            quote_response: quote_response.clone(),
+            config: TransactionConfig::default(),
+        })
+        .await
+        .unwrap();
+
+    println!("Raw tx len: {}", swap_response.swap_transaction.len());
+
+    // Perform further actions as needed...
+
+    // POST /swap-instructions
+    let swap_instructions = jupiter_swap_api_client
+        .swap_instructions(&SwapRequest {
+            user_public_key: TEST_WALLET,
+            quote_response,
+            config: TransactionConfig::default(),
+        })
+        .await
+        .unwrap();
+    println!("{swap_instructions:#?}");
+}
+
+```
+For the full example, please refer to the [examples](../example/) directory in this repository.
 
 ### Using hosted swap API URLs
 
@@ -13,3 +86,8 @@ You can set custom URLs via environment variables for any self-hosted Jupiter AP
 ```
 API_BASE_URL=https://jupiter-swaps.quiknode.pro/D3ADB33F
 ```
+
+## Additional Resources
+
+- [Jupiter Swap API Documentation](https://station.jup.ag/docs/v6/swap-api): Learn more about the Jupiter Swap API and its capabilities.
+- [Jup.ag Website](https://jup.ag/): Explore the official website for additional information and resources.