Skip to content

Commit

Permalink
Clarify the difference with guru.
Browse files Browse the repository at this point in the history
  • Loading branch information
korfuri committed Jul 11, 2017
1 parent 62d820a commit 605a694
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,23 @@ answer questions such as:
* What types implement this interface?
* What interfaces are implemented by this type?

## Usage

Goref, unlike [guru](https://godoc.org/golang.org/x/tools/cmd/guru)
relies in pre-indexing code to make searches faster. Guru is very
convenient when developing in a modest-sized codebase, but calls like
`guru callers -scope ...` are very slow and use a lot of
memory. Instead, goref indexes code once and lets you search it
quickly.

### As a library

Goref can be used as a library, see
its [godoc](http://godoc.org/github.com/korfuri/goref) for usage
information.

### With ElasticSearch

Goref can also be used to index code into ElasticSearch. This is
currently a Work-In-Progress. The binary for this is at
elasticsearch/main/main for lack of a good name until now. Usage is:
Expand Down

0 comments on commit 605a694

Please sign in to comment.