-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 2567381
Showing
2 changed files
with
48 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
<p align="center"> | ||
<a href="https://github.com/eyuelberga/keywrite"> | ||
<img src="https://github.com/eyuelberga/keywrite/blob/master/logo/logo.png?raw=true" alt="Keywrite logo" width="300" /> | ||
</a> | ||
</p> | ||
|
||
<br> | ||
|
||
<p align="center"> | ||
<a href="https://github.com/eyuelberga/keywrite/blob/master/LICENSE"><img alt="GitHub license" src="https://img.shields.io/github/license/eyuelberga/keywrite"></a> | ||
<img alt="build" src="https://travis-ci.org/eyuelberga/keywrite.svg?branch=master"> | ||
<a href="https://openbase.com/js/@keywrite/web?utm_source=embedded&utm_medium=badge&utm_campaign=rate-badge"><img alt="Rate on Openbase" src="https://badges.openbase.com/js/rating/@keywrite/web.svg"></a> | ||
<a href="https://github.com/eyuelberga/keywrite/blob/master/CODE_OF_CONDUCT.md"><img alt="CONTRIBUTING" src="https://img.shields.io/badge/Contributor%20Covenant-2.0-4baaaa.svg"></a> | ||
|
||
</p> | ||
<br /> | ||
|
||
Keywrite is a Javascript library that allows you to type non-latin scripts in any web based application using a standard keyboard. | ||
|
||
## Features 🚀 | ||
|
||
- **Ease of Use:** Keywrite can be integrated to most modern web frameworks with ease. | ||
- **Flexible Keyboard Layouts:** You can configure Keywrite with different keyboard layouts and also change layouts at runtime. | ||
- **Custom Layouts:** You can create your own layouts and add them to Keywrite | ||
- **Fully Extendable:** You can extend the Keywrite core API easily to support different use-cases. | ||
- **Typescript Support:** The codebase is completely written in typescript | ||
|
||
## Installing Keywrite | ||
|
||
To use Keywrite on web projects, all you need to do is install the | ||
`@keywrite/web` package: | ||
|
||
```sh | ||
$ yarn add @keywrite/web | ||
|
||
# or | ||
|
||
$ npm install @keywrite/web | ||
``` | ||
|
||
## Contributing | ||
|
||
Feel like contributing? That's awesome! We have a | ||
[contributing guide](./CONTRIBUTING.md) to help guide you. | ||
|
||
## License | ||
|
||
MIT © [Eyuel Berga](https://github.com/eyuelberga) |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.