Skip to content

Commit

Permalink
Update document
Browse files Browse the repository at this point in the history
  • Loading branch information
souljungkim committed Jan 27, 2020
1 parent 0cbdf86 commit 862e212
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 16 deletions.
29 changes: 19 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,25 @@

## Getting Started

1. Load
```html
<script src="https://cdn.jsdelivr.net/npm/@sj-js/crossman/dist/js/crossman.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/@sj-js/keyman/dist/js/keyman.min.js"></script>
<script>
var keyman = new KeyMan();
</script>
```
0. Load
- Browser
```html
<script src="https://cdn.jsdelivr.net/npm/@sj-js/crossman/dist/js/crossman.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/@sj-js/keyman/dist/js/keyman.min.js"></script>
<script>
var keyman = new KeyMan();
</script>
```
- ES6+
```bash
npm i @sj-js/keyman
```
```js
const KeyMan = require('@sj-js/keyman');
const keyman = new KeyMan();
```

2. Shortcut 등록
1. Shortcut 등록
```js
keyman.addShortcut({
name:'develop-tool',
Expand All @@ -37,7 +46,7 @@
});
```

3. Simple Example
2. Simple Example
```html
<!DOCTYPE html>
<HTML>
Expand Down
8 changes: 4 additions & 4 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@sj-js/keyman",
"version": "1.0.6",
"version": "1.0.7",
"description": "keyman",
"main": "./index.js",
"author": "souljungkim@gmail.com",
Expand All @@ -16,7 +16,7 @@
"web": "https://github.com/sj-js/keyman"
},
"dependencies": {
"@sj-js/crossman": "^1.0.5"
"@sj-js/crossman": "^1.0.7"
},
"devDependencies": {
"gulp": "^4.0.2",
Expand Down

0 comments on commit 862e212

Please sign in to comment.