From 2cd164e79cf58bcc218631d5843b200ce51caff2 Mon Sep 17 00:00:00 2001
From: Jen-Chieh Shen <jcs090218@gmail.com>
Date: Mon, 11 Dec 2023 02:00:56 -0800
Subject: [PATCH] Update README.md

---
 README.md | 71 ++++++++++++++++++++++++++++++++++++++++++++++++++-----
 1 file changed, 65 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 413d8fa..e47f7a3 100644
--- a/README.md
+++ b/README.md
@@ -3,22 +3,22 @@
 # tabulated-list-search 
 > Provide filtering/searching tabulated-list interface.
 
-[![Build Status](https://travis-ci.com/jcs-elpa/tabulated-list-search.svg?branch=master)](https://travis-ci.com/jcs-elpa/tabulated-list-search)
+[![Build Status](https://travis-ci.com/jcs-legacy/tabulated-list-search.svg?branch=master)](https://travis-ci.com/jcs-legacy/tabulated-list-search)
 
 Any package that uses `tabulated-list` as their display could use this 
 library/package to add the search functionalities to enhance the user experience.
 
-[Here](https://github.com/jcs090218/jcs-emacs-init/tree/master/features/buffer-menu-search)
+[Here](https://github.com/jcs-emacs/jcs-emacs/tree/master/features/buffer-menu-search)
 is one example using this package to `*Buffer List*`.
 
-## How does it works?
+## ❓ How does it works?
 
 This package look form each item inside list and do the regular 
 expression matching for target information. If the target 
 information doesn't matched then remove it from the list otherwise 
 keep it inside the list.
 
-## Issue & Improvement
+## 💡 Issue & Improvement
 
 One huge issue is that the performance maybe very slow due to the 
 size of the list itself. Hence the time complexity is `O(n)` and 
@@ -30,11 +30,11 @@ somehow trick the full list not to loop through the whole list.
 Anyway, if you find out the solution feel free to enhance this 
 by making the PR or just open a new issue! Thanks!
 
-## Todo List
+## 📝 Todo List
 
 - [ ] Resolve performance issue explain [here](#issue--improvement).
 
-## Contribute
+## 🛠️ Contribute
 
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)
 [![Elisp styleguide](https://img.shields.io/badge/elisp-style%20guide-purple)](https://github.com/bbatsov/emacs-lisp-style-guide)
@@ -44,3 +44,62 @@ If you would like to contribute to this project, you may either
 clone and make pull requests to this repository. Or you can
 clone the project and establish your own branch of this tool.
 Any methods are welcome!
+
+### 🔬 Development
+
+To run the test locally, you will need the following tools:
+
+- [Eask](https://emacs-eask.github.io/)
+- [Make](https://www.gnu.org/software/make/) (optional)
+
+Install all dependencies and development dependencies:
+
+```sh
+$ eask install-deps --dev
+```
+
+To test package's installation:
+
+```sh
+$ eask package
+$ eask install
+```
+
+To test compilation:
+
+```sh
+$ eask compile
+```
+
+**🪧 The following steps are optional, but we recommend you follow these lint results!**
+
+The built-in `checkdoc` linter:
+
+```sh
+$ eask lint checkdoc
+```
+
+The standard `package` linter:
+
+```sh
+$ eask lint package
+```
+
+*📝 P.S. For more information, find the Eask manual at https://emacs-eask.github.io/.*
+
+## ⚜️ License
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+See [`LICENSE`](./LICENSE.txt) for details.