Skip to content

Commit

Permalink
Resolved merge conflicts.
Browse files Browse the repository at this point in the history
  • Loading branch information
srm985 committed Dec 8, 2018
2 parents d45b582 + bfa89df commit 9cf1154
Show file tree
Hide file tree
Showing 4 changed files with 69 additions and 3 deletions.
52 changes: 52 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,71 @@
# MOK Project - Multilingual Onscreen Keyboard

<<<<<<< HEAD
## We Are Now Serving From A CDN!

### You can now easily include this plugin right in your project without the need to have any code locally.
=======
### We Are Now Serving From A CDN!

#### You can now easily include this plugin right in your project without the need to have any code locally.
>>>>>>> develop
Latest Version
```sh
<script src="https://cdn.jsdelivr.net/npm/mok-project@latest/dist/main.js"></script>
<<<<<<< HEAD

=======
>>>>>>> develop
<link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/mok-project@latest/dist/styles.css">
```

Current Version
```sh
<<<<<<< HEAD
<script src="https://cdn.jsdelivr.net/npm/mok-project@1.1.4/dist/main.js"></script>

<link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/mok-project@1.1.4/dist/styles.css">
```

=======
<script src="https://cdn.jsdelivr.net/npm/mok-project@1.1.5/dist/main.js"></script>
<link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/mok-project@1.1.5/dist/styles.css">
```
_If no local languages file is found, the keyboard will pull languages from the CDN._
<br>
>>>>>>> develop
The goal of this project is to materialize a well-styled, onscreen keyboard capable of supporting numerous languages fed from .klc files generated by Microsoft Keyboard Layout Creator. This has proven to be the most-reliable source of unicode data along with dead keys and ligature support but I am willing to make revisions if a better source is found. Typical use cases for this application include terminals, kiosks, and other touch-point devices. I hope to provide the community with a valuable resource that only grows better with time and your support!
[Super Basic Demo](http://www.seanmcquay.com/mok-project/sample-keyboard.htm)
Current work is underway to develop a variant of the keyboard which is not only condensed in layout but also allows for the keyboard to be appended near the selected input element to facilitate direct entry into the selected field instead of using a modal and dedicated entry field. _(28 June 2017)_
## Usage
To initiate an instance of the keyboard within your application you may include the following script:
```sh
<script src="https://cdn.jsdelivr.net/npm/mok-project@latest/dist/main.js"></script>
<link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/mok-project@latest/dist/styles.css">
<script type="text/javascript">
$(document).ready(function() {
$(document).keyboard({
language: 'us',
keyboardPosition: 'bottom'
});
});
</script>
```

#### Serving Languages

The keyboard will first search for the given language file in `./languages/` and if not found, will pull from the CDN.

## Installation / Running

This project is built with Gulp which sits atop NodeJS.
Expand Down Expand Up @@ -60,6 +102,7 @@ $ gulp develop --sourcemaps

This project was built and tested on jQuery 3.2 and is fed .klc files from [Microsoft Keyboard Layout Creator](https://www.microsoft.com/en-us/download/details.aspx?id=22339) V1.4.

<<<<<<< HEAD
## Usage

To initiate an instance of the keyboard within your application you may include the following script:
Expand All @@ -78,6 +121,8 @@ To initiate an instance of the keyboard within your application you may include
</script>
```

=======
>>>>>>> develop
#### Options

| Option | Default Value | Information |
Expand Down Expand Up @@ -296,3 +341,10 @@ In this release I have addressed several issues related to how the keyboard hand
* Added CDN serving capability!
* Allow mapping from language system file name to native language name.
* Added the ability to configure the keyboard to only activate on specified input fields.
<<<<<<< HEAD
=======

#### Version 1.1.5

* Revised code to search local languages first, then pull from CDN.
>>>>>>> develop
Loading

0 comments on commit 9cf1154

Please sign in to comment.