mirror of
https://github.com/hodgef/simple-keyboard.git
synced 2025-01-19 08:32:57 +08:00
63 lines
2.2 KiB
Markdown
63 lines
2.2 KiB
Markdown
<p>
|
|
<a href="https://simple-keyboard.com/demo">
|
|
<img alt="simple-keyboard: Javscript Virtual Keyboard" src="https://i.imgur.com/Po6659n.gif">
|
|
</a>
|
|
|
|
<a href="https://www.npmjs.com/package/simple-keyboard">
|
|
<img src="https://badgen.net/npm/v/simple-keyboard?color=blue" alt="npm version">
|
|
</a>
|
|
|
|
<a href="https://bundlephobia.com/result?p=simple-keyboard">
|
|
<img src="https://badgen.net/bundlephobia/minzip/simple-keyboard/?color=green" alt="install size">
|
|
</a>
|
|
|
|
<a href="https://travis-ci.org/hodgef/simple-keyboard">
|
|
<img src="https://api.travis-ci.org/hodgef/simple-keyboard.svg?branch=master"
|
|
alt="build status">
|
|
</a>
|
|
|
|
<a href="https://david-dm.org/hodgef/simple-keyboard">
|
|
<img src="https://badgen.net/david/dep/hodgef/simple-keyboard" alt="coverage">
|
|
</a>
|
|
|
|
<a href="https://codecov.io/gh/hodgef/simple-keyboard">
|
|
<img src="https://badgen.net/codecov/c/github/hodgef/simple-keyboard" alt="coverage">
|
|
</a>
|
|
</p>
|
|
|
|
## 🚀 Demo
|
|
[Demo Showcase (Vanilla, Angular, React, Vue)](https://simple-keyboard.com/demo)
|
|
|
|
## 📦 Installation & Usage
|
|
You can use simple-keyboard as a `<script>` tag from a CDN, or install it from npm.
|
|
|
|
Check out the [Getting Started](https://simple-keyboard.com/getting-started) docs to begin.
|
|
|
|
## 📖 Documentation
|
|
Check out the [simple-keyboard documentation](https://simple-keyboard.com/documentation) site.
|
|
|
|
Feel free to browse the [Q&A / Use-cases](https://simple-keyboard.com/qa-use-cases/) page for advanced use-cases.
|
|
|
|
|
|
### To run demo on your own computer
|
|
|
|
* Clone this repository
|
|
* `npm install`
|
|
* `npm start`
|
|
* Visit [http://localhost:3000/](http://localhost:3000/)
|
|
|
|
### Other versions
|
|
|
|
* [React.js](https://github.com/hodgef/react-simple-keyboard)
|
|
* [Angular](https://simple-keyboard.com/demo)
|
|
* [Vue.js](https://simple-keyboard.com/demo)
|
|
|
|
### 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>
|
|
|
|
## ✅ Contributing
|
|
|
|
PR's and issues are welcome. Feel free to submit any issues you have at:
|
|
[https://github.com/hodgef/simple-keyboard/issues](https://github.com/hodgef/simple-keyboard/issues)
|