Skip to content

Commit

Permalink
npm release
Browse files Browse the repository at this point in the history
  • Loading branch information
Raj Nandan Sharma authored and Raj Nandan Sharma committed Jul 11, 2022
1 parent a2edf37 commit be842d2
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .npmrc
Original file line number Diff line number Diff line change
@@ -1 +1 @@
@rajnandan1:registry=https://npm.pkg.github.com
#@rajnandan1:registry=https://npm.pkg.github.com
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,18 @@ From CDN
```
<script src="https://cdn.jsdelivr.net/gh/rajnandan1/floodlightjs@1.0.4/dist/floodlight.min.js"></script>
```
From NPM
```
npm i floodlightjs
import floodlight from 'floodlightjs';
```
## Demo
[Live instance of Floodlight](https://rajnandan1.github.io/floodlightjs/index.html)
## Basic Usage - Implement a quick google search `shift`+`g`

The below code implements a google search using floodgate. It will listen for the `g` key. When someone presses shift+g it will show a search box.
```
//import floodlight from 'floodlightjs'
let fl = new FloodLight();
//this takes to parameters. first parameter is the `key`, second is the description
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@rajnandan1/floodlightjs",
"name": "floodlightjs",
"version": "1.0.4",
"description": "Easily create key board shortcuts for your JS functions. Built using JS only with no other dependency. Inspired from MacOS spotlight ",
"main": "es6/floodlight.js",
Expand Down

0 comments on commit be842d2

Please sign in to comment.