File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -6,21 +6,21 @@ A framework-agnostic on-screen keyboard as a web component. Drops into any page
66
77## Install (without npmjs)
88
9- This package is not published to the npm registry. Each tagged release publishes an ` npm pack ` tarball as a GitHub Release asset. Install it directly :
9+ This package is not published to the npm registry. Install it from GitHub :
1010
1111``` sh
12- npm install https:// github.com/ SoureCode/virtual-keyboard/releases/download/ v0.1.0/sourecode-virtual-keyboard-0.1.0.tgz
12+ npm install github: SoureCode/virtual-keyboard# v0.1.0
1313```
1414
15- Or install from the git tag — the ` prepare ` script will build on install:
15+ The ` prepare ` script builds the library on install. Consumers need ` git ` plus either public-repo access or a PAT/SSH key with read access.
16+
17+ Prefer a prebuilt tarball (no build toolchain on the consumer side)? Each tagged release attaches one as a GitHub Release asset:
1618
1719``` sh
18- npm install github: SoureCode/virtual-keyboard# v0.1.0
20+ npm install https://github.com/ SoureCode/virtual-keyboard/releases/download/ v0.1.0/sourecode-virtual-keyboard-0.1.0.tgz
1921```
2022
21- Consumers of the git-install path need ` git ` plus either public-repo access or a PAT/SSH key with read access to the repo.
22-
23- Then:
23+ Then import:
2424
2525``` ts
2626import { VirtualKeyboard , terminalAdapter , nativeAdapter } from " @sourecode/virtual-keyboard" ;
You can’t perform that action at this time.
0 commit comments