From 961ec4a2b3d7a98cd96800b21409c3f1209fcf6a Mon Sep 17 00:00:00 2001
From: "Jalali-Lab @ UCLA" <16159544+JalaliLabUCLA@users.noreply.github.com>
Date: Wed, 1 Feb 2023 20:49:02 -0800
Subject: [PATCH] update README (#7)

* update readme

* minor

* minor

---------

Co-authored-by: Yiming Zhou <yimingzhou0416@gmail.com>
---
 README.md                 | 43 ++++++++++++++-------------------------
 assets/docs/change_log.md | 25 +++++++++++++++++++++++
 2 files changed, 40 insertions(+), 28 deletions(-)
 create mode 100644 assets/docs/change_log.md

diff --git a/README.md b/README.md
index 13af833..a690f71 100644
--- a/README.md
+++ b/README.md
@@ -5,33 +5,7 @@
 [![Wikipedia](https://img.shields.io/badge/Wikipedia-%23000000.svg?style=for-the-badge&logo=wikipedia&logoColor=white)](https://en.wikipedia.org/wiki/PhyCV)
 [![YouTube](https://img.shields.io/badge/YouTube-%23FF0000.svg?style=for-the-badge&logo=YouTube&logoColor=white)](https://www.youtube.com/playlist?list=PLj--iTBXPaTWABQstUFA6l6_Rf3uiZq9T)
 
-Welcome to PhyCV ! The First Physics-inspired Computer Vision Python library developed by Jalali-Lab @ UCLA.
-
-### *Release Notes*
-
-* **Version 1.2.2**
-
-  Morphological operations are simplified and improved.
-
-* **Version 1.2.1**
-
-  Minor improvements for loading images.
-
-* **Version 1.2.0**
-
-  We release VEViD, an efficient algorithm for both low-light enhancement and color enhancement! We also significantly improved the document and code!
-
-* **Version 1.1.1**
-
-  Fix minor bugs in `page_create_edge` .
-
-* **Version 1.1.0**
-
-  The `load_img` method now supports loading images from both an image files and image arrays.
-
-* **Version 1.0.0**
-  
-  The first release of PhyCV is available!
+Welcome to PhyCV ! The First Physics-inspired Computer Vision Python library developed by Jalali-Lab @ UCLA. Please see the release notes of all previous versions [here](./assets/docs/change_log.md).
 
 ## Contents
 
@@ -51,6 +25,8 @@ Welcome to PhyCV ! The First Physics-inspired Computer Vision Python library dev
 
 * [Reference](#reference)
 
+* [Citation](#citation)
+
 ## Introduction
 
 PhyCV is a Physics-inspired Computer Vision Python library. PhyCV has a new class of computer vision algorithms that emulates the propagation of light through a physical medium with natural and engineered diffractive properties followed by coherent detection. Unlike traditional algorithms that are a sequence of hand-crafted empirical rules, physics-inspired algorithms leverage physical laws of nature as blueprints. These algorithms can, in principle, be implemented in real physical devices for fast and efficient computation. Currently, PhyCV includes Phase-Stretch Transform (PST), Phase-Stretch Adaptive Gradient-field Extractor (PAGE) and Vision Enhancement via Virtual diffraction and coherent Detection (VEViD). Each algorthm has CPU and GPU versions.
@@ -258,4 +234,15 @@ b = 0.2, G = 1.5
 
 [10] Phase-Stretch Adaptive Gradient-Field Extractor (PAGE). MacPhee et al. arXiv preprint arXiv:2202.03570, 2022
 
-[11] VEViD: Vision Enhancement via Virtual diffraction and coherent Detection. Jalali et al. eLight, 2022
\ No newline at end of file
+[11] VEViD: Vision Enhancement via Virtual diffraction and coherent Detection. Jalali et al. eLight, 2022
+
+## Citation
+
+If you find PhyCV useful in your research, please star :star: this repository and consider citing :pencil::
+```
+@article{zhou2023phycv,
+  title={PhyCV: The First Physics-inspired Computer Vision Library},
+  author={Zhou, Yiming and MacPhee, Callen and Suthar, Madhuri and Jalali, Bahram},
+  journal={arXiv preprint arXiv:2301.12531},
+  year={2023}
+}
\ No newline at end of file
diff --git a/assets/docs/change_log.md b/assets/docs/change_log.md
new file mode 100644
index 0000000..b01ec1d
--- /dev/null
+++ b/assets/docs/change_log.md
@@ -0,0 +1,25 @@
+## Change Log
+
+* **Version 1.2.2**
+
+  Morphological operations are simplified and improved.
+
+* **Version 1.2.1**
+
+  Minor improvements for loading images.
+
+* **Version 1.2.0**
+
+  We release VEViD, an efficient algorithm for both low-light enhancement and color enhancement! We also significantly improved the document and code!
+
+* **Version 1.1.1**
+
+  Fix minor bugs in `page_create_edge` .
+
+* **Version 1.1.0**
+
+  The `load_img` method now supports loading images from both an image files and image arrays.
+
+* **Version 1.0.0**
+  
+  The first release of PhyCV is available!
\ No newline at end of file