Merge pull request #5 from eyuelberga/develop

Major version release

.changeset/five-badgers-decide.md

@@ -0,0 +1,8 @@
+---
+'@keywrite/core': major
+'@keywrite/ethiopic-input-methods': major
+'@keywrite/input-method-generator': major
+'@keywrite/web': major
+---
+
+First Major Release

README.md

@@ -14,13 +14,13 @@
 </p>
 <br />
 
-Keywrite is a Javascript library that allows you to type non-latin scripts in any web based application using a standard keyboard.
+Keywrite is a Javascript library that allows you to type non-latin scripts in any web based application using a standard keyboard. See the [Docs](https://eyuelberga.github.io/keywrite) for more info.
 
 ## 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
+-   **Flexible:** You can configure Keywrite with multiple Input-methods, change between them at runtime.
+-   **Custom Input Method:** You can easily define your own Input-methods 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
 

docs/README.md

@@ -1,47 +1,35 @@
-<p align="center">
-  <a href="https://github.com/eyuelberga/keywrite">
-    <img src="https://github.com/eyuelberga/keywrite/blob/main/logo/logo.png?raw=true" alt="Keywrite logo" width="300" />
-  </a>
-</p>
+<img src="assets/logo.png" alt="Keywrite logo" title="Keywrite" width="150" align="right" />
 
-<br>
+# Keywrite
 
-<p align="center">
-<a href="https://github.com/eyuelberga/keywrite/blob/main/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=main">
-<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/main/CODE_OF_CONDUCT.md"><img alt="CONTRIBUTING" src="https://img.shields.io/badge/Contributor%20Covenant-2.0-4baaaa.svg"></a>
+> _type non-latin scripts on the web_
 
-</p>
-<br />
+**Keywrite** is a JavaScript library that allows you to type non-latin scripts in any web based application using a standard keyboard. You can add it to your text input controls and start typing with your configured input-method.
 
-Keywrite is a Javascript library that allows you to type non-latin scripts in any web based application using a standard keyboard.
+The aim of this project is to enable web developers to add support for typing non-latin based texts on web and hybrid applications, so users can type different languages without configuring their operating system or installing additional software.
 
-## Features 🚀
+## Examples
 
--   **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
+[See examples of Keywrite here](examples.md)
 
-## Installing Keywrite
+## The Basics
 
-To use Keywrite on web projects, all you need to do is install the
-`@keywrite/web` package:
+**What does Keywrite do?**
 
-```sh
-$ yarn add @keywrite/web
+1. It allows you to translate key strokes to non-latin characters, which you define in a input-method configuration file.
+1. It binds with web input controls to add multi-lingual typing to your web application
 
-# or
+**Things you can build with Keywrite**
 
-$ npm install @keywrite/web
-```
+1. A web form you want to be filled in a certain language [See Demo]()
+1. A textfield with multiple language support [See Demo]()
+1. A web-based rich-text editor which you can type in multiple languages [See Demo]()
 
 ## Contributing
 
 Feel like contributing? That's awesome! We have a
-[contributing guide](./CONTRIBUTING.md) to help guide you.
+[CONTRIBUTING.md](https://github.com/eyuelberga/keywrite/blob/main/CONTRIBUTING.md)
+to help guide you.
 
 ## License
 

docs/_coverpage.md

@@ -1,8 +1,10 @@
-![logo](_media/logo.png)
+![logo](assets/logo.png)
 
-# Keywrite <small>0.1.0</small>
+> type non-latin scripts on the web
 
-> A Javascript library that allows you to type non-latin scripts in any web based application using a standard keyboard.
+**Keywrite** is a Javascript library that allows you to type non-latin scripts in any web based application using a standard keyboard. You can add it to your text input controls and start typing with your configured input-method.
 
 [GitHub](https://github.com/eyuelberga/keywrite)
-[Get Started](#keywrite)
+[Get Started](README.md)
+
+![color](#D9F8F5)

docs/_sidebar.md

@@ -1,8 +1,14 @@
-<!-- docs/_sidebar.md -->
+-   Getting started
 
--   **Get Started**
-    -   [Installation](/installation)
--   **Basic**
-    -   [Adding to web](/add_to_web)
-    -   [Enable/disable keyboard](/enable_disable)
-    -   [Configuring multiple keyboard-layouts](/multiple_layout)
+    -   [Overview](README.md)
+    -   [Quick Start](quick_start.md)
+
+-   Usage
+    -   [Basic Usage](basic_usage.md)
+    -   [Advanced Usage](advanced_usage.md)
+-   Reference
+    -   [Examples](examples.md)
+    -   [Input Method](input_method.md)
+    -   [Pre-made Input methods](pre_made_input-methods.md)
+    -   [Input Method Generator](input_method_generator.md)
+    -   [Packages](packages.md)

docs/advanced_usage.md

@@ -0,0 +1,9 @@
+# Advanced Usage
+
+## Extending the core package
+
+By extending the exported class from `@keywrite/core` you can add
+app-specific logic. The most important method in the core class would be the
+`write` method. This method takes in a character and resolves it into a special
+symbol as per the input-method specification and returns the symbol and replacement
+state (if previous character needs to be replaced with the new symbol).