From e9ca72fdc2e01225a6f9b52e98c0e92cccb503ba Mon Sep 17 00:00:00 2001 From: Max Guglielmi Date: Sun, 7 Jun 2015 00:16:41 +1000 Subject: [PATCH] Changed the read.me --- README.md | 38 +++++++++++++++++++++++++++++++++----- 1 file changed, 33 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 47f59a44..6d14be85 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,37 @@ -TableFilter -=========== +HTML-Table-Filter-Generator +=========================== Filter HTML tables data easily This script adds to any html table a "filter by column" feature that enables -users to filter and limit the data displayed within a long table. It even works -on tables with uneven rows. The script automatically adds a filter grid bar at -the top of the desired table. +users to filter and limit the data displayed within a long table. The script +automatically adds a filter grid bar at the top of the desired table. + +##Features + +* Convert a regular HTML table into an advanced grid component providing: + * Advanced columns filtering model + * Sorting and pagination facilities + * Complete selection model (addon) + * Extended keyboard navigation (addon) + * Inline cell or row editing (addon) + * Row insertion or deleting (addon) + * And even more behaviors... +* Attach to an existing HTML table +* Integration with any server-side technology as this is a pure client-side +solution +* Callbacks for all events, and delegates for most actions +* Exhaustive documentation and API +* Valuable support provided under a Premium request + +##Install +Start by installing any dependencies. + +```shell +npm install +``` + +## License + +MIT +