From fd4e882aa83ff97d296c39a8a39723be523bf27d Mon Sep 17 00:00:00 2001
From: sreedev <sreedevpadmakumar@gmail.com>
Date: Mon, 23 Jan 2023 14:54:19 -0500
Subject: [PATCH] updated README

---
 README.md | 64 ++++++++++++++++++++++++++++++++++++++-----------------
 1 file changed, 44 insertions(+), 20 deletions(-)

diff --git a/README.md b/README.md
index e5502b9..91fa4c6 100644
--- a/README.md
+++ b/README.md
@@ -4,11 +4,7 @@
   Find, Sort, Filter & Delete duplicate files 
 </p>
 
-<p align="center">
-NOTE: This project is still being developed. At the moment, as shown in the screenshot below, deduplicator is able to scan through and list duplicates with and without caching. Contributions are welcome.
-</p>
-
-<h2 align="center">Usage</h2>
+## Usage
 
 ```bash
 Usage: deduplicator [OPTIONS]
@@ -22,27 +18,55 @@ Options:
   -V, --version            Print version information
 ```
 
-<h2 align="center">Installation</h2>
+## Installation
 
-<p align="center">Currently, deduplicator is only installable via rust's cargo package manager</p>
+### Cargo Install
 
+#### Stable
+
+```bash
+$ cargo install deduplicator
 ```
-cargo install deduplicator
+
+#### Nightly
+
+if you'd like to install with nightly features, you can use
+
+```bash
+$ cargo install --git https://github.com/sreedevk/deduplicator
 ```
-<p align="center">
-  note that if you use a version manager to install rust (like asdf), you need to reshim (`asdf reshim rust`).
-</p>
+Please note that if you use a version manager to install rust (like asdf), you need to reshim (`asdf reshim rust`).
 
-<h2 align="center">Performance</h2>
+### Linux (Pre-built Binary)
 
-<p align="center">
-  Deduplicator uses fxhash (a non-cryptographic hashing algorithm) which is extremely fast. As a result, deduplicator is able to process huge amounts of data in a <del>couple of seconds.</del> few milliseconds.</p>
+you can download the pre-built binary from the [Releases](https://github.com/sreedevk/deduplicator/releases) page.
+download the `deduplicator-x86_64-unknown-linux-gnu.tar.gz` for linux. Once you have the tarball file with the executable,
+you can follow these steps to install:
 
-<p align="center">
-  <del>While testing, Deduplicator was able to go through 8.6GB of pdf files and detect duplicates in 2.9 seconds</del>
-  As of version 0.1.1, on testing locally, deduplicator was able to process and find duplicates in 120GB of files (Videos, PDFs, Images) in ~300ms
-</p>
+```bash
+$ tar -zxvf deduplicator-x86_64-unknown-linux-gnu.tar.gz
+$ sudo mv deduplicator /usr/bin/
+```
 
-<h2 align="center">Screenshots</h2>
+### Mac OS
 
-<img src="https://user-images.githubusercontent.com/36154121/213618143-e5182e39-731e-4817-87dd-1a6a0f38a449.gif" />
+you can download the pre-build binary from the [Releases](https://github.com/sreedevk/deduplicator/releases) page.
+download the `deduplicator-x86_64-apple-darwin.tar.gz` tarball for mac os. Once you have the tarball file with the executable, you can follow these steps to install:
+
+```bash
+$ tar -zxvf deduplicator-x86_64-unknown-linux-gnu.tar.gz
+$ sudo mv deduplicator /usr/bin/
+```
+
+### Windows
+
+you can download the pre-build binary from the [Releases](https://github.com/sreedevk/deduplicator/releases) page.
+download the `deduplicator-x86_64-pc-windows-msvc.zip` zip file for windows. unzip the `zip`  file & move the `deduplicator.exe` to a location in the PATH system environment variable.
+
+## Performance
+
+Deduplicator uses size comparison and fxhash (a non non-cryptographic hashing algo) to quickly scan through large number of files to find duplicates. its also highly parallel (uses rayon and dashmap). I haven't uploaded the benchmarks yet, but I was able to scan through 120GB of files (Videos, PDFs, Images) in ~300ms.
+
+## Screenshots
+
+![](https://user-images.githubusercontent.com/36154121/213618143-e5182e39-731e-4817-87dd-1a6a0f38a449.gif)