keyroute 0.1.0 → 0.1.2

package/README.md

@@ -1,24 +1,47 @@
-# Keyroute
+# keyroute
 
-This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 17.3.0.
+Simple keyboard shortcuts for web applications.  
+Framework-agnostic. Tiny. No dependencies.
 
-## Code scaffolding
+---
 
-Run `ng generate component component-name --project keyroute` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module --project keyroute`.
-> Note: Don't forget to add `--project keyroute` or else it will be added to the default project in your `angular.json` file. 
+## What is keyroute?
 
-## Build
+`keyroute` lets you map keyboard shortcuts to application actions in a simple and predictable way.
+Define your own keyboard shortcut and make your website more accessible.
 
-Run `ng build keyroute` to build the project. The build artifacts will be stored in the `dist/` directory.
+```ts
+createKeyroute({
+  'ctrl+s': () => save(),
+  'esc': () => close()
+});```
 
-## Publishing
+## Installation
 
-After building your library with `ng build keyroute`, go to the dist folder `cd dist/keyroute` and run `npm publish`.
+```bash
+npm install keyroute
+```
 
-## Running unit tests
+## Basic usage in Angular
 
-Run `ng test keyroute` to execute the unit tests via [Karma](https://karma-runner.github.io).
+```ts
+import { createKeyroute } from 'keyroute';
 
-## Further help
+const shortcuts = createKeyroute({
+  'ctrl+s': () => console.log('Saved'),
+  'esc': () => console.log('Closed')
+});
 
-To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.
+// Call when you no longer need the shortcuts
+shortcuts.destroy();
+```
+
+## Contributing
+
+PRs welcome.  
+If you have ideas for:
+- additional key combos
+- accessibility improvements
+- framework helpers
+
+Feel free to open an issue.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "keyroute",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Route keyboard shortcuts to application actions. Framework-agnostic keyboard shortcut routing for web applications",
   "keywords": [
     "keyboard",
@@ -24,6 +24,10 @@
   "dependencies": {
     "tslib": "^2.3.0"
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mervynmanilall/keyroute"
+  },
   "sideEffects": false,
   "module": "fesm2022/keyroute.mjs",
   "typings": "index.d.ts",