readme.md content suggestion

[mo9a7i]

Salam Khalid,

We are a group of programmers/developers that set a target recently to contribute to Arabic open-source projects.

Your project was shared recently among the group discussions and we are willing to extend help to this awesome project where we can.

I have a couple of comments on the readme and introduction of this repo. At first glance, it seems like an academic research project product where it starts with mission/vision/citation methods…etc.
From a user prespective of this repo, its not inviting to use and test, one would have to browse through the text, to reach the installation method.

I would recomment (personal opinion, not sure if others agree) to keep the readme simple and move other content to other areas or documents, here is what I suggest:
1- Create an organization account to move this repo over there, on that organization readme (which islossible now with GitHub) the profile page can be customized to include the introduction, citiation methods, contribution methods, mission, vision, consultation services promo…etc.
2- The readme structure goes like this in simple words
- description of the library
- installation method
- content and listing of modules
- usage examples
- contribution invitation (light text)
- users
- contributers

Finally, thank u and the team for the great efforts.

Regards,
Mohannad

P.S. my profile page in github is not working correctly, I have broken GitHub 😒.