doc: Update readme.md

README.md

@@ -1,42 +1,68 @@
-# Clafrica
+Clafrica
+===
 
-[![crates.io](https://img.shields.io/crates/v/clafrica.svg)](https://crates.io/crates/clafrica)
-[![LICENSE](https://img.shields.io/crates/l/clafrica.svg)](https://github.com/pythonbrad/clafrica/blob/main/LICENSE)
-![Rust](https://github.com/pythonbrad/clafrica/workflows/Rust/badge.svg)
-[![docs.rs](https://docs.rs/clafrica/badge.svg)](https://docs.rs/clafrica)
-[![Chat](https://img.shields.io/discord/1101565344692318320?logo=discord&logoColor=white)](https://discord.gg/C6TDEgzDzY)
-[![Coverage Status](https://coveralls.io/repos/github/pythonbrad/clafrica/badge.svg?branch=main)](https://coveralls.io/github/pythonbrad/clafrica?branch=main)
+  [![crates.io](https://img.shields.io/crates/v/clafrica.svg)](https://crates.io/crates/clafrica)
+  [![LICENSE](https://img.shields.io/crates/l/clafrica.svg)](https://github.com/pythonbrad/clafrica/blob/main/LICENSE)
+  ![Rust](https://github.com/pythonbrad/clafrica/workflows/Rust/badge.svg)
+  [![docs.rs](https://docs.rs/clafrica/badge.svg)](https://docs.rs/clafrica)
+  [![Chat](https://img.shields.io/discord/1101565344692318320?logo=discord&logoColor=white)](https://discord.gg/C6TDEgzDzY)
+  [![Coverage Status](https://coveralls.io/repos/github/pythonbrad/clafrica/badge.svg?branch=main)](https://coveralls.io/github/pythonbrad/clafrica?branch=main)
 
+  Clafrica (a.k.a clafrica-rs) is an input method for African languages. It's designed to make it easier for people who speak African languages to type on their computers.
 
-Clafrica is an input method for African languages. It's designed to make it easier for people who speak African languages to type on their computers.
+License
+---
+  [MIT](LICENSE) license.
 
-## Features
+Features
+===
 
-- Support for multiple African languages
-- Easy to use interface
-- Customizable dictionary
-- Support for both desktop and web platform.
+  - [ ] Support for multiple African languages 
+  - [ ] Easy to use interface 
+  - [ ] Customizable dictionary 
+  - [ ] Support for both desktop and web platform.
 
-## Installation
+Installation
+===
 
-To use the input method, follow these steps:
+Build dependencies (Linux only)
+---
+  - libxtst-dev
+  - libevdev-dev
+  - libxdo-dev
 
-1. Clone the repository to your local machine.
-2. Install the required dependencies.
-3. Run the application.
+Runtime dependencies (Linux only)
+---
+  - libxtst-dev
+  - libevdev-dev
+  - libxdo-dev
 
-## Usage
+In using cargo
+---
+  `cargo install clafrica`
 
-To use the input method, simply select the language you want to type in and start typing. The keyboard layout can be customized to suit your needs. 
+Try it in the console
+---
+  `clafrica` comes with a REPL application which can be used to test if his library is working.
+  To use the clafrica, simply provide the path of the datafile that suit your needs.
+
+  Eg. `clafrica clafrica_codes.txt`
 
-## Contributing
+Frontends
+===
 
-If you would like to contribute to this project, please fork the repository and submit a pull request with your changes. 
+  Official:
+  - [clafrica-wish](https://github.com/pythonbrad/clafrica-wish): Frontend for desktop environment.
 
-## Credits
+  Community:
+  - nothing for the moment
 
-This input method was developed by Fomegne Brady with contributions from the open-source community. 
+Similar works
+===
 
-## License
+  - [clafrica](https://github.com/H-Theking/clafrica): Python version
 
-This project is licensed under the [MIT](LICENSE) license.
+Contributing
+===
+
+  If you would like to contribute to this project, please fork the repository and submit a pull request with your changes.