Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
diamondburned committed May 26, 2023
1 parent 4e2d701 commit cd51351
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,20 @@ I cannot get Flakes to work, no one was able to help me for days, so I decided
to [fix the Nix channels issues
myself](https://github.com/diamondburned/nix-bonito).

Unstable Nix versions (2.3+) break all of `nix`'s subcommands including `nix
Unstable Nix versions (2.4+) break all of `nix`'s subcommands including `nix
search`, so I decided to make a better `nix search` that works with stable Nix
versions.

## Goals

The goals of `nix-search` is to be fast and useful. Nix 2.3's `nix search` is
rather weak and slow in its searching capabilities, so this aims to be better
than that.
rather weak and slow in its searching capabilities, and Nix 2.4's `nix search`
is even slower, so this aims to be better than that.

`nix-search` will go with an indexing-based approach, where it will index
packages and their attributes into a searching database. This will allow for
faster searching and more accurate results. [Bleve](https://blevesearch.com/)
will be used for the indexing.
`nix-search` goes with an indexing-based approach, where it indexes packages
and their attributes into a searching database. This allows for faster
searching and more accurate results.
[Bluge](https://github.com/blugelabs/bluge) is used for the indexing.

`nix-search` will also eventually feature a lightweight expression evaluator
that will allow for more accurate results. This will allow for more flexible
Expand All @@ -42,7 +42,7 @@ TODO: make `default.nix`

### Go

```go
```sh
go install libdb.so/nix-search/cmd/nix-search@latest
```

Expand Down

0 comments on commit cd51351

Please sign in to comment.