From 6493b643ecfdf5b25af935f4668af0181c162eaa Mon Sep 17 00:00:00 2001
From: Qingping Hou <dave2008713@gmail.com>
Date: Sat, 12 Mar 2016 01:07:40 -0800
Subject: [PATCH] doc: Event page

---
 doc/Events.md | 10 ++++++++++
 doc/config.ld |  2 +-
 2 files changed, 11 insertions(+), 1 deletion(-)
 create mode 100644 doc/Events.md

diff --git a/doc/Events.md b/doc/Events.md
new file mode 100644
index 000000000..c0cfe60c3
--- /dev/null
+++ b/doc/Events.md
@@ -0,0 +1,10 @@
+Builtin Events
+==============
+
+Reader Events
+-------------
+
+* UpdatePos: emitted by typesetting related modules to notify other modules to
+recalculate the view based on the new typesetting.
+
+* PosUpdate: emitted by readerrolling module to signal a change in pos.
diff --git a/doc/config.ld b/doc/config.ld
index 9fa5fd846..c78c36fa1 100644
--- a/doc/config.ld
+++ b/doc/config.ld
@@ -5,7 +5,7 @@ title = 'KOReader Documentation'
 dir = 'html'
 style = '!fixed'
 use_markdown_titles = true
-topics = {'../README.md', './Hacking.md'}
+topics = {'../README.md', './Hacking.md', './Events.md'}
 package = ''
 format = 'markdown'
 sort_modules = true