more docs

bored-charts/README.md

@@ -2,6 +2,11 @@
 
 Build easy, minimal, PDF-able data reports with markdown and python.
 
+The idea is you do your analysis in Python, as you normally would, and dumping your
+figures into a nice report written in markdown is now super low-effort: you decorate
+the function to generate the figure (that you already wrote when doing your analysis)
+and it becomes available to bored-charts so you can present your findings clearly.
+
 ## Minimal example
 
 Install bored-charts and uvicorn:
@@ -10,10 +15,10 @@ Install bored-charts and uvicorn:
 pip install bored-charts uvicorn
 ```
 
-Create your app:
+### Create your app
 
 ```python
-# app.py
+# main.py
 from pathlib import Path
 
 import plotly.express as px
@@ -39,34 +44,41 @@ app = boredcharts(
 )
 ```
 
-Write a markdown report:
+### Write a markdown report
 
 ```md
-<!-- pages/populations.md -->
-
 ## Populations
 
 USA's population has been growing linearly for the last 70 years:
 
 {{ figure("usa_population") }}
 ```
 
-Run your app:
+### Run your app
 
 ```bash
-uvicorn app:app --reload
+uvicorn main:app --reload
 ```
 
+🎉Now you can view your reports at [http://localhost:8000](http://localhost:8000)!
+
+## Going further
+
 A more full project structure might look like this:
 
 ```
 my-reports
 ├── myreports
-│   ├── pages <-- put your markdown reports here
+│   ├── pages           <-- put your markdown reports here
 │   │   └── example.md
-│   ├── **init**.py
-│   ├── app.py <-- spin up the app here
-│   └── figures.py <-- define your figures here
+│   ├── __init__.py
+│   ├── app.py          <-- spin up the app here
+│   └── figures.py      <-- define your figures here
 ├── README.md
 └── pyproject.toml
 ```
+
+## Extensibility
+
+The bored-charts app is just a FastAPI (ASGI) app,
+so you can integrate it into your existing projects or extend it as needed.