From 9193fd9b06c80585b0ad19a1b72665f19b69823c Mon Sep 17 00:00:00 2001
From: Faris Ansari <netchampfaris@users.noreply.github.com>
Date: Thu, 12 Dec 2024 16:14:54 +0530
Subject: [PATCH] Update README.md (#201)

---
 README.md | 73 ++++++++++++++++++++++---------------------------------
 1 file changed, 29 insertions(+), 44 deletions(-)

diff --git a/README.md b/README.md
index f8a58f4..e63f1ec 100644
--- a/README.md
+++ b/README.md
@@ -1,55 +1,34 @@
-<div align="center">
-    <img src="https://github.com/frappe/design/raw/master/logos/logo-2019/frappe-datatable-logo.png" height="128">
-    <h2>Frappe DataTable</h2>
-    <p align="center">
-    <p>
-    A modern datatable library for the web
-    </p>
+<div align="center" markdown="1">
+
+<img width="80" alt="datatable-logo" src="https://github.com/user-attachments/assets/8235f4b9-993a-4329-97de-9431dcf63aae" >
+
+<h1>Frappe DataTable</h1>
+
+**A modern datatable library for the web**
 
 [![Test and Release](https://github.com/frappe/datatable/workflows/Test%20and%20Release/badge.svg)](https://github.com/frappe/datatable/actions?query=workflow%3A%22Test+and+Release%22)
 [![npm version](https://badge.fury.io/js/frappe-datatable.svg)](https://badge.fury.io/js/frappe-datatable)
-[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](http://opensource.org/licenses/MIT)
 ![npm bundle size (minified + gzip)](https://img.shields.io/bundlephobia/minzip/frappe-datatable.svg)
-[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
 
 
+![datatable-demo-2](https://user-images.githubusercontent.com/9355208/40740030-5412aa40-6465-11e8-8542-b0247ab1daac.gif)
+
 </div>
 
-## Introduction
+## Frappe Datatable
 
 Frappe DataTable is a simple, modern and interactive datatable library for displaying tabular data. Originally built for [ERPNext](https://github.com/frappe/erpnext), it can be used to render large amount of rows without sacrificing performance and has the basic data grid features like inline editing and keyboard navigation. It does not require jQuery, unlike most data grids out there.
 
-## Demo
-
-![datatable-demo-2](https://user-images.githubusercontent.com/9355208/40740030-5412aa40-6465-11e8-8542-b0247ab1daac.gif)
+### Motivation
 
-## Features
+I was trying to remove all legacy UI components from the [frappe](https://github.com/frappe/frappe) codebase. We were using [SlickGrid](https://github.com/mleibman/SlickGrid) for rendering tables. It was unmaintained and UI was dated. Other datatable solutions either didn't have the features we needed or were closed source. So we built our own.
 
-### Cell Features
 
-* Custom Formatters
-* Inline Editing
-* Mouse Selection
-* Copy Cells
-* Keyboard Navigation
-* Custom Cell Editor
+### Key Features
 
-### Column Features
-
-* Reorder Columns
-* Sort by Column
-* Remove / Hide Column
-* Custom Actions
-* Resize Column
-* Flexible Layout
-
-### Row Features
-
-* Row Selection
-* Tree Structured Rows
-* Inline Filters
-* Large Number of Rows
-* Dynamic Row Height
+- **Cell**: Enable editing within individual cells and features like custom formatters, inline editing, and mouse selection. Users can easily copy cell content, navigate through cells using the keyboard, and take advantage of a custom cell editor for advanced functionality.
+- **Column**: Columns are highly flexible, allowing users to reorder, resize, and sort them with ease. Additional features include hiding/removing columns and adding custom actions.
+- **Row**: Rows support advanced interactions, including row selection, tree-structured organization, and inline filters for precise control. They handle large datasets efficiently with dynamic row heights.
 
 ## Install
 
@@ -73,18 +52,24 @@ const datatable = new DataTable('#datatable', {
 });
 ```
 
-## Contribution
+## Development Setup
 
 * `yarn start` - Start dev server
 * Open `index.html` located in the root folder, and start development.
 * Run `yarn lint` before committing changes
 * This project uses [commitizen](https://github.com/commitizen/cz-cli) for conventional commit messages, use `yarn commit` command instead of `git commit`
 
-## Read the blog
+## Links
 
-[Making a new datatable for the web](https://medium.com/frapp%C3%A9-thoughts/things-i-learned-building-a-library-for-the-web-6846a588bf53)
+- [Making a new datatable for the web](https://medium.com/frapp%C3%A9-thoughts/things-i-learned-building-a-library-for-the-web-6846a588bf53)
 
-
-## License
-
-[MIT](http://opensource.org/licenses/MIT)
+<br>
+<br>
+<div align="center" style="padding-top: 0.75rem;">
+	<a href="https://frappe.io" target="_blank">
+		<picture>
+			<source media="(prefers-color-scheme: dark)" srcset="https://frappe.io/files/Frappe-white.png">
+			<img src="https://frappe.io/files/Frappe-black.png" alt="Frappe Technologies" height="28"/>
+		</picture>
+	</a>
+</div>