upaated README

closes blevesearch#16
machunleilei · Jul 31, 2014 · 7a174d7 · 7a174d7
1 parent 3eb63a8
commit 7a174d7
Show file tree

Hide file tree

Showing 4 changed files with 43 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,39 @@
-# bleve
+# ![bleve](docs/bleve.png) bleve
 
-[![Build Status](https://drone.io/github.com/couchbaselabs/bleve/status.png)](https://drone.io/github.com/couchbaselabs/bleve/latest)
-[![Coverage Status](https://coveralls.io/repos/couchbaselabs/bleve/badge.png?branch=master)](https://coveralls.io/r/couchbaselabs/bleve?branch=master)
+modern text indexing in go
+
+## Features
+* Index any go data structure (including JSON)
+* Intelligent defaults backed up by powerful configuration
+* Supported field types:
+    * Text
+* Supported query types:
+    * Term, Phrase, Match, Match Phrase
+    * Conjunction, Disjunction, Boolean
+    * Simple query syntax for human entry
+* Search result match highlighting
+
+## Indexing
+
+		message := struct{
+			From: "[email protected]",
+			Body: "bleve indexing is easy",
+		}
+
+		mapping := bleve.NewIndexMapping()
+		index, _ := bleve.Open("example.bleve", mapping)
+		index.IndexId(message)
 
-A modern text indexing library for go.
+## Querying
+
+		mapping := bleve.NewIndexMapping()
+		index, _ := bleve.Open("example.bleve", mapping)
+		query := bleve.NewSyntaxQuery("bleve")
+		searchRequest := bleve.NewSearchRequest(query)
+		searchResult, _ := index.Search(searchRequest)
+
+
+## Status
+
+[![Build Status](https://drone.io/github.com/couchbaselabs/bleve/status.png)](https://drone.io/github.com/couchbaselabs/bleve/latest)
+[![Coverage Status](https://coveralls.io/repos/couchbaselabs/bleve/badge.png?branch=master)](https://coveralls.io/r/couchbaselabs/bleve?branch=master)
diff --git a/docs/bleve.png b/docs/bleve.png
diff --git a/examples/bleve_query/main.go b/examples/bleve_query/main.go
@@ -48,7 +48,7 @@ func main() {
 	// build a search with the provided parameters
 	queryString := strings.Join(flag.Args(), " ")
 	query := bleve.NewSyntaxQuery(queryString)
-	searchRequest := bleve.NewSearchRequest(query, *limit, *skip, *explain)
+	searchRequest := bleve.NewSearchRequestOptions(query, *limit, *skip, *explain)
 
 	// enable highlights if requested
 	if *includeHighlights {

diff --git a/search.go b/search.go
@@ -73,7 +73,11 @@ func (r *SearchRequest) UnmarshalJSON(input []byte) error {
 
 }
 
-func NewSearchRequest(q Query, size, from int, explain bool) *SearchRequest {
+func NewSearchRequest(q Query) *SearchRequest {
+	return NewSearchRequestOptions(q, 10, 0, false)
+}
+
+func NewSearchRequestOptions(q Query, size, from int, explain bool) *SearchRequest {
 	return &SearchRequest{
 		Query:   q,
 		Size:    size,