github.com/balzaczyy/golucene@v0.0.0-20151210033525-d0be9ee89713/README.md (about)

     1  [![Build Status](https://travis-ci.org/balzaczyy/golucene.svg?branch=master)](https://travis-ci.org/balzaczyy/golucene)
     2  [![Coverage Status](https://coveralls.io/repos/balzaczyy/golucene/badge.png?branch=lucene410)](https://coveralls.io/r/balzaczyy/golucene?branch=lucene410)
     3  [![GoDoc](https://godoc.org/github.com/balzaczyy/golucene?status.svg)](https://godoc.org/github.com/balzaczyy/golucene)
     4  
     5  golucene
     6  ========
     7  
     8  A [Go](http://golang.org) port of [Apache Lucene](http://lucene.apache.org). Check out the online demo [here](http://hamlet.zhouyiyan.cn/)!
     9  
    10  Sync to Lucene Java 4.10 2014/10/22
    11  
    12  Why do we need yet another port of Lucene?
    13  ------------------------------------------
    14  
    15  Since Lucene Java is already optimized to teeth (and yes, I know it very much), potential performance gain should not be expected from its Go port. Quote from Lucy's FAQ:
    16  
    17  >Is Lucy faster than Lucene? It's written in C, after all.
    18  
    19  >That depends. As of this writing, Lucy launches faster than Lucene thanks to tighter integration with the system IO cache, but Lucene is faster in terms of raw indexing and search throughput once it gets going. These differences reflect the distinct priorities of the most active developers within the Lucy and Lucene communities more than anything else.
    20  
    21  It also applies to GoLucene. But some benefits can still be expected:
    22  - quick start speed;
    23  - able to be embedded in Go app;
    24  - goroutine which I think can be faster in certain case;
    25  - ready-to-use byte, array utilities which can reduce the code size, and lead to easy maintenance.
    26  
    27  Though it started as a pet project, I've been pretty serious about this.
    28  
    29  Dependencies
    30  ------------
    31  Go 1.2+
    32  
    33  Installation
    34  ------------
    35  
    36  	go get -u github.com/balzaczyy/golucene
    37  
    38  Usage
    39  -----
    40  
    41  Using GoLucene is similar to using Lucene Java. Firstly, index need
    42  to be built first. Then, create an query and do the search against
    43  the index.
    44  
    45  Note that the current GoLucene is rather basic and limited in feature.
    46  Only default functions are supported, like term frequency based
    47  weight calculation, filesystem directory, boolean query, etc. For
    48  further features, please raise requests.
    49  
    50  A detailed example can be found [here](gl.go).
    51  
    52  License
    53  -------
    54  Apache Public License 2.0.