docs: update README

README.md

@@ -1,3 +1,35 @@
 # pfund-plot
 
-A high-level out-of-the-box, domain-specific plotting library for financial data visualization designed for traders.
+A high-level out-of-the-box, domain-specific plotting library for **financial data visualization designed for traders**.
+
+
+> This library is not ready, please wait for version 0.0.1 release.
+
+
+## Why pfund-plot?
+This library is designed for traders who just want to get their data visualized and displayed in the simplest way possible, 
+there is almost no learning curve.
+
+
+## Core Features
+- [x] Multi-Display Mode: support displaying plots in a *Jupyter notebook*, *Marimo notebook*, *browser* and *desktop window*
+- [x] Streaming Data: support streaming data in real-time by just setting `streaming=True`
+- [x] DataFrame Agnostic: support pandas, polars, and dask
+- [x] Financial Plots: e.g. candlestick, orderbook, trades etc.
+
+
+
+## Installation
+```bash
+pip install pfund-plot
+```
+
+
+## Usage
+```python
+import pfund_plot as plt
+
+# TODO: get some sample data using pfeed
+data = ...
+fig = plt.ohlc(data)
+```

docs/.gitignore

@@ -0,0 +1,2 @@
+# MyST build outputs
+_build

docs/myst.yml

@@ -0,0 +1,31 @@
+# See docs at: https://mystmd.org/guide/frontmatter
+version: 1
+project:
+  id: 9ef23ea6-8e87-40ea-b3e9-5b4782dfc759
+  title: PFund-Plot's Documentation
+  description: A library for financial data visualization, dashboard creation, and template sharing.
+  keywords: ["financial data", "plotting", "dashboards", "charts", "data visualization", "graphs", "plots"]
+  exclude: 
+    - README.md
+  github: https://github.com/PFund-Software-Ltd/pfund-plot
+site:
+  template: book-theme
+  nav:
+    - title: pfund
+      url: https://github.com/PFund-Software-Ltd/pfund
+    - title: pfeed
+      url: https://github.com/PFund-Software-Ltd/pfeed
+    - title: pfolio
+      url: https://github.com/PFund-Software-Ltd/pfolio
+    - title: pytrade.org
+      url: https://pytrade.org
+  options:
+    favicon: images/favicon.ico
+    logo: images/logo-light.svg
+    logo_text: democratize algo-trading
+    analytics_google: GA_TRACKING_ID_PLACEHOLDER
+  actions:
+    - title: Join Our Community
+      url: https://pfund.ai
+    - title: ⭐ Star
+      url: https://github.com/PFund-Software-Ltd/pfund-plot