Update README

1 files changed, 43 insertions, 0 deletions

diff --git a/README.org b/README.org
index 1db334b..c3e886a 100644
--- a/README.org
+++ b/README.org
@@ -9,6 +9,49 @@ compatible with [[https://edwardtufte.github.io/tufte-css/][Tufte CSS]] out of t
 
 It's still a work-in-progress, but it works pretty well right now.
 
+* Installation and Usage
+
+Currently you need to manually install, do something like:
+
+#+BEGIN_SRC emacs-lisp
+(add-to-list 'load-path "/path/to/ox-tufte")
+(require 'ox-tufte)
+#+END_SRC
+
+For usage, when exporting simple select "Tufte HTML" instead of regular HTML
+export from the export menu (=C-c C-e=).
+
+* Features
+
+ox-tufte supports *most* of the features from tufte-css, some in different ways
+than expected.
+
+- Footnotes become numbered Sidenotes from the tufte spec
+- Margin notes can be created by having a link to ~mn:<n>~ where the link text
+  gets transformed to the margin note, for example:
+
+#+BEGIN_SRC fundamental
+This is some regular text [[mn:1][this will be a margin note]]
+#+END_SRC
+
+- Anything in =#+BEGIN_QUOTE= blocks becomes an epigraph, where the =#+NAME= of
+  the quote becomes a reference in the ~<footer>~ inside of the epigraph.
+- Verses (=#+BEGIN_VERSE=) are treated the same as quotes, however they preserve
+  leading spaces in the text
+
+* Customization
+
+There is only a single customization right now,
+~org-tufte-include-footnotes-at-bottom~. Because footnotes are transformed to
+sidenotes they are currently hidden on very narrow screens (like phones), if you
+want to include footnodes *also* at the bottom of the page, this may be set to
+=t=.
+
+* TODOs
+- Add the ability to use the ~fullwidth~ class on figures
+- Support =#+CAPTION= better on images
+- Tufte image quilts?
+
 * References
 - https://edwardtufte.github.io/tufte-css/
 - https://gitlab.com/snippets/22309