From 589e137ebf9416da75063e71f7d54f34e5d09b30 Mon Sep 17 00:00:00 2001
From: skip405 <skip405@gmail.com>
Date: Fri, 30 Dec 2022 11:15:36 +0300
Subject: [PATCH] Readme updated with usage examples

---
 README.md | 46 +++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 45 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 91e8228..b915293 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,45 @@
-Convert cyrillic Belarusian characters to Latin characters using transliteration. Can transliterate in accordance with the "Instruction on transliteration of geographical names" or in accordance with the rules of the Belarusian Latin alphabet (Łacinka). Can slugify the resulted transliterated string.
\ No newline at end of file
+# belLit
+
+Convert cyrillic Belarusian characters to Latin characters using transliteration. Can transliterate in accordance with the ["Instruction on transliteration of geographical names"](https://en.wikipedia.org/wiki/Instruction_on_transliteration_of_Belarusian_geographical_names_with_letters_of_Latin_script) or in accordance with the rules of the [Belarusian Latin alphabet (Łacinka)](https://en.wikipedia.org/wiki/Belarusian_Latin_alphabet). Can slugify the resulted transliterated string.
+
+## Installation
+
+```
+npm i @skip405/bel-lat
+```
+
+## Usage
+
+By default, the package transliterates in accordance with the Łacinka rules.
+
+```javascript
+import belLat from '@skip405/bel-lat';
+
+belLat('Лацінка') // Łacinka
+```
+
+which is equivalent to:
+
+```javascript
+import belLat from '@skip405/bel-lat';
+
+belLat('Лацінка', { style: 'lacinka' }) // Łacinka
+```
+
+You can specify conversion in accordance with the instruction for geographical names, e.g.
+
+```javascript
+import belLat from '@skip405/bel-lat';
+
+belLat('Лацінка', { style: 'geographical' }) // Lacinka
+```
+
+## Testing
+
+```
+npm test
+```
+
+## License
+
+The MIT License (MIT). Please see [License File](LICENSE) for more information.
\ No newline at end of file