Missing rust README.md

[Alex-ley-scrub]

Love the work!

We’ve been evaluating this for a performance dictionary lookup bottleneck we have. We’ve been using Python (pykeyvi) so far and it’s great.

Our code base is 90% Python but we’re using pyO3/Maturin to build rust extensions as well for performance critical functions. It works really well and the tooling is great.

So, I’m also curious about using keyvi directly from rust and I see you have bindings: https://crates.io/crates/keyvi

But I see there’s no README.md? Would it be possible to add one with some examples etc. please? I could do a basic PR with some examples if helpful but since I’ve not used it yet, it’s a bit of a chicken and egg problem.

At the minute I’m looking at the rust tests to get an idea of how to use it. If there’s any other resources please let me know!

[hendrikmuhs]

Hi @Alex-ley-scrub,

thanks for the feedback. I agree a README / documentation is missing, especially for the rust extension.

What I can assure you: The rust extension is heavily used at a larger scale, so it is maintained and can be considered stable. However as in general, the documentation can be better.