Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dedukun committed Aug 19, 2020
1 parent 7243083 commit 4215a40
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# kokatu

Kokatu is a POSIX script which works as a wrapper for [fd](https://github.com/sharkdp/fd) and [ripgrep](https://github.com/BurntSushi/ripgrep),
kokatu is a POSIX script which works as a wrapper for [fd](https://github.com/sharkdp/fd) and [ripgrep](https://github.com/BurntSushi/ripgrep),
bringing a similar functionality to mlocate, i.e, it indexes the system files and then allows the user to search in this index.

## Requirements
Expand Down Expand Up @@ -53,7 +53,7 @@ diff --git a/kokatu b/kokatu

## Performance

The following performance times were measured using [hyperfine](https://github.com/sharkdp/hyperfine), with the command
The following performance times were measured using [hyperfine](https://github.com/sharkdp/hyperfine), with the command:
```bash
$ hyperfine --warmup 3 "locate README.md" "kokatu -d /tmp/kokatu.db README.md" "kokatu -d /tmp/kokatu_compressed.db.lz4 README.md"
```
Expand All @@ -66,12 +66,12 @@ The conditions of the indexes where the following:
| kokatu (no compression) | 111M | 1487040 |
| kokatu (with compression) | 17M | 1487775 |

***NOTE:*** There might be a bug in the way fd is being used, or missing options, but every time the system is indexed, the number of entries is diffenrent.
***NOTE:*** There might be a bug in the way fd is being used, or missing options, but every time the system is indexed, the number of entries is different.

![](images/performance.png?raw=true)

## TODO

- Check why every time the system is indexed, the
- Check why every time the system is indexed, the index has diffenret number of entries
- Add option to only index from a certain path
- Configuration file

0 comments on commit 4215a40

Please sign in to comment.