From 5d9245260486bc1a43b1c0843a17b860e291d98d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Damir=20Jeli=C4=87?= Date: Thu, 6 Jun 2019 12:12:57 +0200 Subject: [PATCH] README: Rename the project to tantivy-py and mention that the are py3 only. --- Cargo.toml | 2 +- README.md | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 0d3001d..e108ee4 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,5 +1,5 @@ [package] -name = "tantivy-python" +name = "tantivy-py" version = "0.1.0" authors = ["Damir Jelić "] edition = "2018" diff --git a/README.md b/README.md index 6738bec..c26d619 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -python-tantivy -============== +tantivy-py +========== Python bindings for tantivy. @@ -8,15 +8,15 @@ Python bindings for tantivy. The bindings can be installed using setuptools: - python setup.py install --user + python3 setup.py install --user Note that this requires setuptools-rust to be installed. Another thing to note is that the bindings are using [PyO3](https://github.com/PyO3/pyo3), which -requires rust nightly currently. +requires rust nightly and only supports python3. # Usage -python-tantivy has a similar API to tantivy. To create a index first a schema +tantivy-py has a similar API to tantivy. To create a index first a schema needs to be built. After that documents can be added to the index and a reader can be created to search the index.