docs: update readme

Author: luchobonatti

README.md

@@ -4,43 +4,48 @@
 [![Release](https://github.com/BootNodeDev/uni-dev-kit/actions/workflows/release.yml/badge.svg)](https://github.com/BootNodeDev/uni-dev-kit/actions/workflows/release.yml)
 [![Docs](https://img.shields.io/badge/docs-typedoc-blue)](https://bootnodedev.github.io/uni-dev-kit)
 
-A modern TypeScript library for integrating Uniswap V4 into your dapp.
+> Modern TypeScript SDK for integrating Uniswap V4 into your dapp.  
+> **Early version:** API may change rapidly.
 
-## Installation
+---
+
+## Install
 
 ```bash
 pnpm install uniswap-dev-kit
+# or
+npm install uniswap-dev-kit
 ```
 
 ## Quick Start
 
 ### 1. Configure and create an SDK instance
 
 ```ts
-import { createInstance } from 'uniswap-dev-kit';
+import { createInstance } from "uniswap-dev-kit";
 
 const config = {
   chainId: 1,
-  rpcUrl: 'https://eth.llamarpc.com',
+  rpcUrl: "https://eth.llamarpc.com",
   contracts: {
-    poolManager: '0x...',
-    positionDescriptor: '0x...',
-    positionManager: '0x...',
-    quoter: '0x...',
-    stateView: '0x...',
-    universalRouter: '0x...',
-    permit2: '0x...'
+    poolManager: "0x...",
+    positionDescriptor: "0x...",
+    positionManager: "0x...",
+    quoter: "0x...",
+    stateView: "0x...",
+    universalRouter: "0x...",
+    permit2: "0x..."
   }
 };
 
 createInstance(config);
 ```
 
-### 2. Use the getQuote function (vanilla JS/TS)
+### 2. Get a quote (vanilla JS/TS)
 
 ```ts
-import { getQuote } from 'uniswap-dev-kit';
-import { parseEther } from 'viem';
+import { getQuote } from "uniswap-dev-kit";
+import { parseEther } from "viem";
 
 const quote = await getQuote({
   tokens: [
@@ -49,25 +54,19 @@ const quote = await getQuote({
   ],
   feeTier: 3000,
   tickSpacing: 60,
-  amountIn: parseEther("1"), // 1 ETH in wei
+  amountIn: parseEther("1"),
   zeroForOne: true
 });
 console.log(quote.amountOut);
 ```
 
-**Parameters of getQuote:**
-- `tokens`: `[tokenA, tokenB]` (addresses)
-- `feeTier`: pool fee (e.g. 3000)
-- `tickSpacing`: pool tick spacing (e.g. 60)
-- `amountIn`: amount to swap (bigint, e.g. `parseEther("1")`)
-- `zeroForOne`: swap direction (true: tokenA→tokenB)
-- `hooks` and `hookData`: optional
+### 3. Use in React (with hooks)
 
-### 3. Use the useGetQuote hook (React)
+#### Get a quote
 
 ```tsx
-import { useGetQuote } from 'uniswap-dev-kit';
-import { parseEther } from 'viem';
+import { useGetQuote } from "uniswap-dev-kit";
+import { parseEther } from "viem";
 
 function QuoteComponent() {
   const { data, isLoading, error } = useGetQuote({
@@ -89,10 +88,74 @@ function QuoteComponent() {
 }
 ```
 
-## Documentation
+#### Get a pool
+
+```tsx
+import { useGetPool } from "uniswap-dev-kit";
+
+function PoolComponent() {
+  const { data, isLoading, error } = useGetPool({
+    params: {
+      tokens: [
+        "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
+        "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2"
+      ],
+      fee: 3000,
+      chainId: 1
+    }
+  });
+
+  if (isLoading) return <span>Loading...</span>;
+  if (error) return <span>Error: {error.message}</span>;
+  return <span>Pool: {JSON.stringify(data)}</span>;
+}
+```
+
+---
+
+## API Reference
+
+See [full TypeDoc documentation](https://bootnodedev.github.io/uni-dev-kit) for all methods, types, and advanced usage.
+
+---
+
+## Development
+
+### Scripts
+
+- `pnpm build` — Build the library
+- `pnpm test` — Run all tests
+- `pnpm lint` — Lint code with Biome
+- `pnpm format` — Format code with Biome
+- `pnpm docs` — Generate API docs with TypeDoc
+
+### Contributing
+
+See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines.
+
+### Release
+
+- Releases are automated with [semantic-release](https://semantic-release.gitbook.io/semantic-release/).
+- Versioning: [semver](https://semver.org/)
+
+---
+
+## FAQ
+
+- **Which React versions are supported?**  
+  React 18+ (see peerDependencies)
+- **Does it work in Node and browser?**  
+  Yes, but hooks are React-only.
+- **Can I use my own ABIs?**  
+  Yes, but Uniswap V4 ABIs are included.
+
+---
+
+## License
 
-See [API Documentation](https://bootnodedev.github.io/uni-dev-kit) for full API reference.
+MIT
 
 ---
 
-> This is an early version. API and features will evolve rapidly. 
+> Feedback, issues, and PRs welcome.  
+> [API Docs](https://bootnodedev.github.io/uni-dev-kit) • [Open an Issue](https://github.com/BootNodeDev/uni-dev-kit/issues)