Skip to content

Commit

Permalink
docs(readme): minimal development instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
cmdoret committed Sep 6, 2024
1 parent b0136ea commit 1e3f749
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,7 @@ cargo build --release

## usage

### Command line interface


### command line interface

To filter the top 3 matches in a file non-interactively:

Expand All @@ -40,7 +38,6 @@ let matcher = TermMatcher::from_readers(vec![r1, r2])
matcher.rank_terms("some query")
```


### python package

```python
Expand All @@ -52,3 +49,12 @@ matcher.score("query") # returns the match score of each term for the input quer
matcher.rank("query") # returns the list of terms sorted by similarity with the query.
matcher.top("query", 5) # shows top 5 most similar results (sorted).
```

## development

A nix dev shell with all build dependencies is provided.
Assuming just and nix are installed on the machine, you can enter the shell with:

```shell
just nix-develop
```

0 comments on commit 1e3f749

Please sign in to comment.