Update README.md (#88)

QuantEcon · Apr 6, 2021 · 4b60fb3 · 4b60fb3 · github-actions · Apr 6, 2021
1 parent 68c589c
commit 4b60fb3
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,22 @@
 # quantecon-book-theme
 A Jupyter Book Theme for QuantEcon Book Style Projects
 
+## Usage
+
+To use this theme in [Jupyter Book](https://github.com/executablebooks/jupyter-book):
+
+1. Install the theme
+
+  `pip install git+https://github.com/QuantEcon/quantecon-book-theme.git`
+
+2. Add the theme to your `_config.yml` file:
+
+  ```yaml
+  sphinx:
+      config:
+          html_theme: quantecon_book_theme
+  ```
+
 ## Updating Fixtures for Tests
 
 ### Updating test regression files on layout changes