snap-records 1.1.6 → 1.1.8

package/CONTRIBUTING.md

@@ -0,0 +1,31 @@
+# Contributing to SnapRecords
+
+> By participating in this project, you agree to abide by its [Code of Conduct](./docs/COC.md).
+
+First off, thank you for considering contributing to SnapRecords! It's people like you that make open source such a great community.
+
+## How Can I Contribute?
+
+### Reporting Bugs
+
+- Ensure the bug was not already reported by searching on GitHub under [Issues](https://github.com/your-username/snap-records/issues).
+- If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/your-username/snap-records/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
+
+### Suggesting Enhancements
+
+- Open a new issue to suggest an enhancement. Please provide a clear description of the enhancement and its potential benefits.
+
+### Pull Request Process
+
+1. Fork the repo and create your branch from `main`.
+2. If you've added code that should be tested, add tests.
+3. If you've changed APIs, update the documentation.
+4. Ensure the test suite passes (`npm test`).
+5. Make sure your code lints (`npm run lint`).
+6. Issue that pull request!
+
+We will review your pull request as soon as possible.
+
+## Code of Conduct
+
+This project and everyone participating in it is governed by the [SnapRecords Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.

package/README.md

@@ -25,7 +25,7 @@
 
 **SnapRecords** is a powerful, flexible TypeScript-based data grid component for displaying, managing, and interacting with tabular data in web applications.
 
-Inspired by [jQuery Dynatable](https://github.com/alfajango/jquery-dynatable), it modernizes the concept with type safety, enhanced features, and performance optimizations.
+Inspired by <a href="https://github.com/alfajango/jquery-dynatable" target="_blank" rel="noopener noreferrer">jQuery Dynatable</a>, it modernizes the concept with type safety, enhanced features, and performance optimizations.
 
 It supports server-side pagination, sorting, filtering, caching, multiple rendering modes, and accessibility, making it ideal for both simple and complex data-driven interfaces.
 
@@ -65,7 +65,7 @@ To quickly set up SnapRecords:
     import { SnapRecords, RowsPerPage } from './SnapRecords';
 
     new SnapRecords('table-container', {
-        url: '[https://api.example.com/data](https://api.example.com/data)',
+        url: 'https://api.example.com/data',
         columns: ['id', 'name'],
         rowsPerPage: RowsPerPage.DEFAULT,
         // No theme specified, so it uses 'default' and inherits host page styles
@@ -234,7 +234,7 @@ api.setRenderMode(RenderType.MOBILE_CARDS);
 
 ## Configuration Options
 
-The `SnapRecordsOptions<T>` interface defines all configuration options. Key options include (see `config.md` for full details):
+The `SnapRecordsOptions<T>` interface defines all configuration options. Key options include (see <a href="https://github.com/lbassuncao/SnapRecords/blob/main/docs/CONFIG.md" target="_blank" rel="noopener noreferrer">config.md</a> for full details):
 
 - `url` (string, required): API URL for data fetching.
 - `columns` (string[], required): Column keys to display.
@@ -311,7 +311,7 @@ Override styles in your CSS as needed.
 SnapRecords prioritizes accessibility:
 
 - **ARIA Attributes**: Supports `aria-sort`, `aria-selected`, `aria-label` for table, list, and card modes.
-- **Keyboard Navigation**: ArrowUp/Down for row navigation, Enter/Space for selection, PageUp/Down for pagination (see `keyboard.md`).
+- **Keyboard Navigation**: ArrowUp/Down for row navigation, Enter/Space for selection, PageUp/Down for pagination (see <a href="https://github.com/lbassuncao/SnapRecords/blob/main/docs/KEYBOARD.md" target="_blank" rel="noopener noreferrer">keyboard.md</a>).
 - **Screen Reader Support**: Announces updates (e.g., row selection, mode changes) via ARIA live regions.
 
 ## State Management
@@ -464,7 +464,7 @@ Customize rendering or event handling by providing custom `renderer`, `eventMana
 
 ## License
 
-MIT License. See [`LICENSE`](./docs/LICENSE.txt) for details.
+MIT License. See <a href="https://github.com/lbassuncao/SnapRecords/blob/main/LICENSE" target="_blank" rel="noopener noreferrer">LICENSE</a> for details.
 
 ## Support
 

package/package.json

@@ -1,9 +1,4 @@
 {
-    "files": [
-        "dist",
-        "LICENSE",
-        "README.md"
-    ],
     "keywords": [
         "datatable",
         "data-grid",
@@ -22,7 +17,7 @@
         "jquery-dynatable"
     ],
     "type": "module",
-    "version": "1.1.6",
+    "version": "1.1.8",
     "name": "snap-records",
     "dependencies": {
         "dexie": "^4.0.11",