1//  Copyright (c) 2014 Couchbase, Inc.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// 		http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15/*
16Package bleve is a library for indexing and searching text.
17
18Example Opening New Index, Indexing Data
19
20    message := struct{
21        Id:   "example"
22        From: "marty.schoch@gmail.com",
23        Body: "bleve indexing is easy",
24    }
25
26    mapping := bleve.NewIndexMapping()
27    index, _ := bleve.New("example.bleve", mapping)
28    index.Index(message.Id, message)
29
30Example Opening Existing Index, Searching Data
31
32    index, _ := bleve.Open("example.bleve")
33    query := bleve.NewQueryStringQuery("bleve")
34    searchRequest := bleve.NewSearchRequest(query)
35    searchResult, _ := index.Search(searchRequest)
36
37*/
38package bleve
39