2018-10-29 22:41:08 +08:00
|
|
|
<div align="center">
|
2018-10-29 23:08:02 +08: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>
|
2018-11-28 06:49:12 +08:00
|
|
|
<a href="https://simple-keyboard.com/demo" title="View Demo" target="_blank"><img src="https://franciscohodge.com/project-pages/simple-keyboard/images/skdemo-4x2.gif" align="center" width="100%"></a>
|
2018-10-29 23:08:02 +08:00
|
|
|
<blockquote>The easily customisable and responsive on-screen virtual keyboard for Javascript projects.</blockquote>
|
2018-10-29 22:48:02 +08:00
|
|
|
<a href="https://www.npmjs.com/package/simple-keyboard" target="_blank"><img src="https://img.shields.io/npm/v/simple-keyboard.svg?style=flat" alt="npm version"></a>
|
|
|
|
|
<a href="https://travis-ci.org/hodgef/simple-keyboard" target="_blank"><img src="https://travis-ci.org/hodgef/simple-keyboard.svg?branch=master" alt="Build Status"></a>
|
|
|
|
|
<a href="https://codecov.io/gh/hodgef/simple-keyboard" target="_blank"><img src="https://img.shields.io/codecov/c/github/hodgef/simple-keyboard/master.svg?style=flat" alt="Coverage Status"></a>
|
|
|
|
|
<a href="https://doc.esdoc.org/github.com/hodgef/simple-keyboard" target="_blank"><img src="https://doc.esdoc.org/github.com/hodgef/simple-keyboard/badge.svg" alt="Documentation Status"></a>
|
2018-11-26 07:16:05 +08:00
|
|
|
<img src="https://img.shields.io/david/dev/hodgef/simple-keyboard.svg" alt="Dev dependencies">
|
|
|
|
|
<a href="https://www.codacy.com/app/hodgef/simple-keyboard?utm_source=github.com&utm_medium=referral&utm_content=hodgef/simple-keyboard&utm_campaign=Badge_Grade" target="_blank"><img src="https://api.codacy.com/project/badge/Grade/5778fccc6a894701853d9a1f2fb44a76" alt="Codacy Badge"></a>
|
2018-10-29 23:13:40 +08:00
|
|
|
</p>
|
2018-10-29 22:41:08 +08:00
|
|
|
</div>
|
2018-04-21 04:34:02 +08:00
|
|
|
|
2018-10-29 23:02:21 +08:00
|
|
|
## 📦 Installation & Usage
|
2018-10-21 02:37:06 +08:00
|
|
|
You can use simple-keyboard as a `<script>` tag from a CDN, or install it from npm.
|
2018-10-21 02:21:40 +08:00
|
|
|
|
2018-10-21 02:47:31 +08:00
|
|
|
Check out the [Getting Started](https://simple-keyboard.com/getting-started) docs to begin.
|
2018-04-21 04:34:02 +08:00
|
|
|
|
2018-10-29 23:02:21 +08:00
|
|
|
## 📖 Documentation
|
2018-10-21 02:47:31 +08:00
|
|
|
Check out the [simple-keyboard documentation](https://simple-keyboard.com/documentation) site.
|
2018-04-24 21:38:14 +08:00
|
|
|
|
2018-10-21 02:21:40 +08:00
|
|
|
Feel free to browse the [Q&A / Use-cases](https://simple-keyboard.com/qa-use-cases/) page for advanced use-cases.
|
2018-09-25 03:52:54 +08:00
|
|
|
|
2018-10-29 23:02:21 +08:00
|
|
|
## 🚀 Demo
|
2018-04-21 04:34:02 +08:00
|
|
|
|
2018-10-21 02:29:14 +08:00
|
|
|
[https://simple-keyboard.com/demo](https://simple-keyboard.com/demo)
|
2018-04-21 04:34:02 +08:00
|
|
|
|
2018-05-31 10:28:51 +08:00
|
|
|
|
2018-04-21 04:34:02 +08: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 22:59:11 +08:00
|
|
|
### Other versions
|
2018-04-21 04:34:02 +08:00
|
|
|
|
2018-11-26 09:15:15 +08:00
|
|
|
* [React.js](https://github.com/hodgef/react-simple-keyboard)
|
|
|
|
|
* [Angular](https://simple-keyboard.com/demo)
|
|
|
|
|
* [Vue.js](https://simple-keyboard.com/demo)
|
2018-06-08 22:59:11 +08:00
|
|
|
|
2018-10-09 07:12:51 +08: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-10-29 23:02:21 +08:00
|
|
|
## ✅ Contributing
|
2018-06-08 22:59:11 +08:00
|
|
|
|
|
|
|
|
PR's and issues are welcome. Feel free to submit any issues you have at:
|
2018-04-21 04:34:02 +08:00
|
|
|
[https://github.com/hodgef/simple-keyboard/issues](https://github.com/hodgef/simple-keyboard/issues)
|
