diff --git a/.gitignore b/.gitignore index 9f11b755..1fe1b00e 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ .idea/ +node_modules/ diff --git a/README.md b/README.md index 8120338e..dd1f6de8 100644 --- a/README.md +++ b/README.md @@ -1,50 +1,91 @@ -keycharm -======== +# keycharm Easy and free library for binding keys. +## Install + Keycharm is on npm so you can install it with: -``` + +```bash npm install keycharm ``` +## Import + +### IIFE (browser) -Example: +After importing the script `keycharm` is availible globally: +```html +