Update readme

docpress · Oct 20, 2015 · f67e1d7 · f67e1d7
1 parent 2807aec
commit f67e1d7
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -20,3 +20,8 @@ It takes them from all `.html` files (which `docpress-core` converted from Markd
 It also updates `ms.metadata()` to add `assets/search.js` to the `js` list.
 
 It is meant to be used alongside `docpress-core` and `docpress-base`.
+
+The frontend provides these available in the browser:
+
+* `Search.search('keyword')` - searches pages and headings
+* `Search.pages` - an index of all pages and headings
diff --git a/index.js b/index.js
@@ -92,6 +92,7 @@ function lunrize (idx) {
   const lunr = require('lunr')
   const index = lunr(function () {
     this.field('title', { boost: 10 })
+    // todo: boost if heading
     this.field('pagetitle', { boost: 3 })
     this.field('body')
     this.ref('slug')