From 68f9e0055da0ab436c32cedb76abff4b15b8301a Mon Sep 17 00:00:00 2001
From: x <powturbo@gmail.com>
Date: Sat, 1 Apr 2023 16:33:20 +0200
Subject: [PATCH] TurboPFor : Rust bindings

---
 rust/README.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 rust/README.md

diff --git a/rust/README.md b/rust/README.md
new file mode 100644
index 0000000..7ce10a6
--- /dev/null
+++ b/rust/README.md
@@ -0,0 +1,21 @@
+# Rust bindings for TurboPFor-Integer-Compression
+
+This is a wrapper for [TurboPFor Integer Compression](https://github.com/powturbo/TurboPFor-Integer-Compression).
+
+## Installation
+1- Prerequistes: build and install the TuroPFor library libic.a into /usr/local/lib  
+
+2 - Use the provided src/bindings.rs file or generate a new rust bindings.rs file.
+```shell
+cargo build
+```
+3 - Test 
+```shell
+cargo test
+```
+## Examples
+ - see the tests.rs file in the src folder
+ - a list of public functions are available in the bindings.rs file
+ 
+## Reference
+- [bindgen automatically generates Rust FFI bindings to C and C++ libraries.](https://rust-lang.github.io/rust-bindgen/)