Merge pull request #57 from ebastos/readme_improvement

Improve README

Author: gboudreau

README.md

@@ -1,7 +1,22 @@
 Unofficial Wealthsimple API Library for Python
 ==============================================
 
-This library allows you to access your own account using the Wealthsimple (GraphQL) API using Python.
+This library allows you to access your own Wealthsimple account using the Wealthsimple (GraphQL) API.
+
+> **Python 3.10+ required**
+
+Features
+--------
+
+- Retrieve all accounts (RRSP, TFSA, FHSA, cash, margin, crypto, credit card)
+- Get account balances and positions
+- Fetch historical performance (net value, deposits, gains)
+- Access transaction/activity history
+- Search securities and get market data
+- Historical price quotes
+- Handle 2FA (TOTP) authentication
+- Automatic session refresh
+- Optional security data caching
 
 Installation
 ------------
@@ -12,8 +27,22 @@ uv add ws-api
 pip install ws-api
 ```
 
-Usage
------
+### Basic Example
+
+```python
+from ws_api import WealthsimpleAPI
+
+# Login (will prompt for username/password/TOTP)
+session = WealthsimpleAPI.login(username="you@example.com", password="yourpassword")
+ws = WealthsimpleAPI.from_token(session)
+
+# Get your accounts
+accounts = ws.get_accounts()
+for account in accounts:
+    print(f"{account['description']}: {account['number']}")
+```
+
+### Full Example
 
 Note: You'll need the keyring package to run the code below. Install with: `uv add keyring` (or `pip install keyring`)
 
@@ -159,3 +188,8 @@ if __name__ == "__main__":
     WSApiTest().main()
 
 ```
+
+Projects Using It
+-----------------
+
+- [wealthgrabber](https://github.com/ebastos/wealthgrabber) - Wealthsimple portfolio analytics