Updated README.md

README.md

@@ -1,2 +1,63 @@
 # alphabetic
-A lightweight Python library for querying the alphabet of languages
+A lightweight Python module for querying the alphabet of languages
+
+# Description
+Alphabetic is a small project that was born out of the need to find out the alphabet of several languages for a private NLP project. Determining the alphabet of a language is required for various NLP tasks, e.g. for classifying the language of a given text or for normalizing it (e.g., by removing noisy/random strings). 
+
+The idea is simple: given the name of the desired language (e.g. *German*, *Serbian*, *Estonian*, etc.), Alphabetic first translates the language internally into an [ISO 639-2](https://www.loc.gov/standards/iso639-2/php/code_list.php) language code and then returns the corresponding alphabet. 
+
+# Installation
+The easiest way to install Alphabetic is to use pip, where you can choose between (1) the PyPI repository and (2) this repository. 
+
+- (1) ```pip install alphabetic```
+
+- (2) ```pip install git+https://github.com/Halvani/alphabetic.git```
+
+The latter will pull and install the latest commit from this repository as well as the required Python dependencies. 
+
+# Usage
+A simple lookup of a language's alphabet can be performed as follows:
+```python
+from alphabetic import Language, Alphabet
+
+print(*Alphabet.by_language(Language.Greek))
+
+# Α Β Γ Δ Ε Ζ Η Θ Ι Κ Λ Μ Ν Ξ Ο Π Ρ Σ Τ Υ Φ Χ Ψ Ω α β γ δ ε ζ η θ ι κ λ μ ν ξ ο π ρ σ τ υ φ χ ψ ω
+```
+
+The output of  ```by_language``` is a simple list of utf8-strings. Depending on the selected language, the alphabet can be further restricted in terms of letter casing: 
+
+```python
+from alphabetic import Language, Alphabet, LetterCase 
+
+print(*Alphabet.by_language(Language.Czech, letter_case=LetterCase.Lower))
+
+# h a b c c h d e f g h i j k l m n o p q r s t u v w x y z á é í ó ú ý č ď ě ň ř š ť ů ž
+```
+However, for some languages (e.g. *Hebrew* or *Arabic*, which have no upper/lower case) such restrictions are not possible. Therefore, in such cases, the entire alphabet is returned...
+
+```python
+from alphabetic import Language, Alphabet, LetterCase 
+
+print(*Alphabet.by_language(Language.Hebrew, letter_case=LetterCase.Lower))
+
+# א ב ג ד ה ו ז ח ט י כ ך ל מ ם נ ן ס ע פ ף צ ץ ק ר ש ת
+
+print(*Alphabet.by_language(Language.Arabic, letter_case=LetterCase.Lower))
+
+# ا ب ة ت ث ج ح خ د ذ ر ز س ش ص ض ط ظ ع غ ف ق ك ل م ن ه و ي
+```
+
+# Features
+- Currently 53 languages are supported, with more to follow over time. 
+- At the heart of Alphabetic is a Json file that can be used independently of the respective programming language or application
+- 
+
+# Contribution
+If you like this project, you are welcome to support it, e.g. by providing additional languages  (there is a lot to do with regard to [ISO 639-2](https://www.loc.gov/standards/iso639-2/php/code_list.php)). Feel free to fork the repository and create a pull request to suggest and collaborate on changes.
+
+# Last remarks
+As is usual with open source projects, we developers are not interested in making money, but primarily to give something back to the community with fun and joy. Nevertheless, we would be very happy if you rewarded all the time that has gone into the project with just a small star 🤗 
+
+
+