Document fork status

devoxel · devoxel · commit 3329a5db875f · 2024-10-23T12:48:26.000+01:00
The README explains the justification of the fork. Mention the issues for visibility from the original repo: - Merge HubSpot/sortable#54 - Address HubSpot/sortable#46
diff --git a/README.md b/README.md
@@ -1,9 +1,23 @@
-## Sortable
+## sortable-table
 
-<a href="https://eager.io/app/sortable/install?source=button">
-  <img src="https://install.eager.io/install-button.png" border="0" width="126">
-</a>
+### Overview
 
-##### [Demo](http://github.hubspot.com/sortable/docs/welcome) &nbsp;&nbsp; [Documentation](http://github.hubspot.com/sortable)
+Sortable is an open-source JavaScript and CSS library which adds sorting
+functionality to tables. It is tiny (`<2kb` min+gzip) and has no dependencies.
 
-Sortable is an open-source JavaScript and CSS library which adds sorting functionality to tables. It is tiny (`<2kb` min+gzip) and has no dependencies.
+### Fork Status
+
+This is a fork of [HubSpot/sortable](https://github.com/HubSpot/sortable).
+Due to a lack of maintenance, I felt it prudent to open a fork.
+
+I will only look at PRs for critical / performance issues - I like the
+simplicity of the original.
+
+Changes include:
+
+- Updates dev tooling to latest version (as of Oct 2024).
+- Merged Hubspot/sortable#54 - "Fix performance issues with large tables". Thanks @hjacobs for writing this code.
+- Addressed Hubspot/sortable#46 - "touch devices fires sorting twice". This if fixed to just use the touchstart event on mobile.
+- Addressed a race with the DOM - I didn't file an issue for this one, but the script can run before DOM is ready, meaning the onclick events are not setup. I encoutered this when creating large tables and having the script in the `<head>`.
+
+I will make this available on a CDN for easy access.
