Skip to content

Commit

Permalink
Merge pull request #11 from am11/docs
Browse files Browse the repository at this point in the history
Improve readme example
  • Loading branch information
bleroy authored Jul 29, 2020
2 parents 9bbb138 + a939c27 commit b19dbd3
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,13 @@ var index = await Index.Build(async builder =>
Then searching is as simple as:

```csharp
await foreach (Result result in idx.Search("love"))
await foreach (Result result in index.Search("love"))
{
// do something with that result
}
```

This returns a list of matching documents with a score of how closely they match the search query as well as any associated metadata about the match:
This returns a list of matching documents with a [score](https://lunrjs.com/guides/searching.html#scoring) of how closely they match, the search query as well as any associated metadata about the match:

```csharp
new List<Result>
Expand Down

0 comments on commit b19dbd3

Please sign in to comment.