Skip to content
This repository has been archived by the owner on May 29, 2022. It is now read-only.

Commit

Permalink
Update package information
Browse files Browse the repository at this point in the history
  • Loading branch information
aslamplr committed Mar 13, 2020
1 parent d560522 commit f4b4c88
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 1 deletion.
2 changes: 2 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ name = "unicode-to-mltt-converter"
version = "0.1.0"
authors = ["Aslam Ahammed <aslamplr@gmail.com>"]
edition = "2018"
repository = "https://github.com/aslamplr/unicode-to-mltt-converter"
license = "(MIT OR Apache-2.0)"

[lib]
crate-type = ["cdylib", "rlib"]
Expand Down
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
Malayalam unicode to mltt converter

<div align="center">

<h1>Malayalam unicode to mltt converter</h1>
Expand All @@ -10,7 +12,21 @@

## 🚴 Usage

### 🖥 Run CLI util
### 🌎 Web example

Requires bundler such as webpack with appropriate wasm loaders to consume the library.
See the example in `www` directory for complete web application.

```javascript
import * as mlttConverter from 'unicode-to-mltt-converter';

fetch("www/public/karthika.map").then((resp) => resp.text()).then((defaultCharmapVal) => {
mlttConverter.convert(inputValue, defaultCharmapVal);
});

```

### 🖥 Run Rust 🦀 CLI util

```
cargo run -- www/public/karthika.map "പശ്ചിമഘട്ടത്തിലെ ചുരുക്കം സ്ഥലങ്ങളിൽ മാത്രം വിരളമായി കാണപ്പെടുന്ന ഒരിനം പൂമ്പാറ്റയാണ് മലബാർ മിന്നൻ"
Expand Down Expand Up @@ -38,3 +54,10 @@ wasm-pack test --headless --firefox
```

## 🕸 Web Application using React is in the `www` directory inside this repo. Separate `README.md` included for `www`.


## Development dependencies

- rustc 1.41.1
- wasm-pack 0.9.1
- node v13.7.0

0 comments on commit f4b4c88

Please sign in to comment.