Init.

README.md

@@ -0,0 +1,29 @@
+# OPHE Test Implementation
+
+
+
+## Requirements
+Rust 1.59.0+ stable
+
+
+# Running the cryptoservice
+```ROCKET_PORT=9999 cargo run --release --bin cryptoservice```
+
+# Running the webclient
+A rudimentary webclient is available. Currently providing a custom message(for now 32 bytes of value 0 are encrypted) for encryption is not possbile.
+
+```cargo run --release --bin ophe```
+Go to http://localhost:8000/rapidoc to checkout the documentation.
+# Benchmarking
+Benchmark can be run by ```cargo test --release  -- --nocapture```
+
+Of course it should be done using --release otherwise performance optimization do not run
+
+Every performance test can be edited to specify the number of threads used by changing 1 in
+``` rayon::ThreadPoolBuilder::new().num_threads(1).build_global().unwrap(); ``` to the number of threads you want to use (Meaning the mulitple cpu cores can be used)
+
+
+Tested with Rust 1.59.0 stable
+
+## Todo
+- Split core functionality from the webclient code into 2 seperate crates