2018-10-20 14:21:40 -04:00
|
|
|
[](https://github.com/hodgef/simple-keyboard/blob/master/LICENSE)
|
|
|
|
|
[](https://www.npmjs.com/package/simple-keyboard)
|
2018-10-14 22:52:00 -04:00
|
|
|
[](https://travis-ci.org/hodgef/simple-keyboard)
|
2018-10-16 18:00:21 -04:00
|
|
|
[](https://codecov.io/gh/hodgef/simple-keyboard)
|
2018-10-24 18:49:46 -04:00
|
|
|
[](https://doc.esdoc.org/github.com/hodgef/simple-keyboard)
|
2018-10-14 18:58:03 -04:00
|
|
|
[](http://franciscohodge.com/simple-keyboard/chat/join)
|
2018-07-19 10:13:09 -04:00
|
|
|
|
2018-10-20 14:21:40 -04:00
|
|
|
<a href="https://simple-keyboard.com/demo" title="View Demo" target="_blank"><img src="https://franciscohodge.com/project-pages/simple-keyboard/images/simplekeyboard-banner_B.png" align="center" width="100%"></a>
|
|
|
|
|
<a href="https://simple-keyboard.com/demo" title="View Demo" target="_blank"><img src="https://franciscohodge.com/project-pages/simple-keyboard/images/simple-keyboard-10172018.gif" align="center" width="100%"></a>
|
2018-04-20 16:34:02 -04:00
|
|
|
|
2018-05-30 23:15:01 -04:00
|
|
|
> The easily customisable and responsive on-screen virtual keyboard for Javascript projects.
|
2018-04-20 16:34:02 -04:00
|
|
|
|
2018-10-24 18:53:33 -04:00
|
|
|
## Installation & Usage
|
2018-10-20 14:37:06 -04:00
|
|
|
You can use simple-keyboard as a `<script>` tag from a CDN, or install it from npm.
|
2018-10-20 14:21:40 -04:00
|
|
|
|
2018-10-20 14:47:31 -04:00
|
|
|
Check out the [Getting Started](https://simple-keyboard.com/getting-started) docs to begin.
|
2018-04-20 16:34:02 -04:00
|
|
|
|
2018-10-20 14:47:31 -04:00
|
|
|
## Documentation
|
|
|
|
|
Check out the [simple-keyboard documentation](https://simple-keyboard.com/documentation) site.
|
2018-04-24 09:38:14 -04:00
|
|
|
|
2018-10-20 14:21:40 -04:00
|
|
|
Feel free to browse the [Q&A / Use-cases](https://simple-keyboard.com/qa-use-cases/) page for advanced use-cases.
|
2018-09-24 15:52:54 -04:00
|
|
|
|
2018-04-20 16:34:02 -04:00
|
|
|
## Demo
|
|
|
|
|
|
2018-10-20 14:29:14 -04:00
|
|
|
[https://simple-keyboard.com/demo](https://simple-keyboard.com/demo)
|
2018-04-20 16:34:02 -04:00
|
|
|
|
2018-05-30 22:28:51 -04:00
|
|
|
|
2018-04-20 16:34:02 -04:00
|
|
|
### To run demo on your own computer
|
|
|
|
|
|
|
|
|
|
* Clone this repository
|
|
|
|
|
* `npm install`
|
|
|
|
|
* `npm start`
|
|
|
|
|
* Visit [http://localhost:3000/](http://localhost:3000/)
|
|
|
|
|
|
2018-06-08 10:59:11 -04:00
|
|
|
### Other versions
|
2018-04-20 16:34:02 -04:00
|
|
|
|
2018-06-08 10:59:11 -04:00
|
|
|
* ReactJS - [react-simple-keyboard](https://github.com/hodgef/react-simple-keyboard)
|
|
|
|
|
|
2018-10-08 19:12:51 -04:00
|
|
|
### Questions?
|
|
|
|
|
|
|
|
|
|
<a href="http://franciscohodge.com/simple-keyboard/chat/join" title="Join our Discord chat" target="_blank"><img src="https://franciscohodge.com/project-pages/simple-keyboard/images/discord.png" align="center" width="200"></a>
|
|
|
|
|
|
2018-06-08 10:59:11 -04:00
|
|
|
## Contributing
|
|
|
|
|
|
|
|
|
|
PR's and issues are welcome. Feel free to submit any issues you have at:
|
2018-04-20 16:34:02 -04:00
|
|
|
[https://github.com/hodgef/simple-keyboard/issues](https://github.com/hodgef/simple-keyboard/issues)
|
