From 9115361f008b7b038d67c959c7879356244afb28 Mon Sep 17 00:00:00 2001
From: Auro <35087590+MrAuro@users.noreply.github.com>
Date: Fri, 31 Mar 2023 17:52:31 -0700
Subject: [PATCH] (docs): Improve README file for Navi

---
 navi/{navi => }/README.md | 14 ++++++++------
 1 file changed, 8 insertions(+), 6 deletions(-)
 rename navi/{navi => }/README.md (70%)

diff --git a/navi/navi/README.md b/navi/README.md
similarity index 70%
rename from navi/navi/README.md
rename to navi/README.md
index d8962daf45..d139292924 100644
--- a/navi/navi/README.md
+++ b/navi/README.md
@@ -1,6 +1,6 @@
 # Navi: High-Performance Machine Learning Serving Server in Rust
 
-Navi is a high-performance, versatile machine learning serving server implemented in Rust, tailored for production usage. It's designed to efficiently serve within the Twitter tech stack, offering top-notch performance while focusing on core features.
+Navi is a high-performance, versatile machine learning serving server implemented in Rust and tailored for production usage. It's designed to efficiently serve within the Twitter tech stack, offering top-notch performance while focusing on core features.
 
 ## Key Features
 
@@ -23,12 +23,14 @@ While Navi's features may not be as comprehensive as its open-source counterpart
 - `thrift_bpr_adapter`: generated thrift code for BatchPredictionRequest
 
 ## Content
-We include all *.rs source code that makes up the main navi binaries for you to examine. The test and benchmark code, as well as configuration files are not included due to data security concerns.
+We have included all *.rs source code files that make up the main Navi binaries for you to examine. However, we have not included the test and benchmark code, as well as various configuration files, due to data security concerns.
 
 ## Run
-in navi/navi you can run. Note you need to create a models directory and create some versions, preferably using epoch time, e.g., 1679693908377
-- scripts/run_tf2.sh
-- scripts/run_onnx.sh
+In navi/navi, you can run the following commands:
+- `scripts/run_tf2.sh` for [TensorFlow](https://www.tensorflow.org/)
+- `scripts/run_onnx.sh` for [Onnx](https://onnx.ai/)
+
+Do note that you need to create a models directory and create some versions, preferably using epoch time, e.g., `1679693908377`.
 
 ## Build
-you can adapt the above scripts to build using Cargo
+You can adapt the above scripts to build using Cargo.
\ No newline at end of file