wip

Author: karam-mustafa

README.md

@@ -1,45 +1,42 @@
-![logo](assets/logo.png)
-
-Design a simple and expressive logo with the same model you see above,
-the logo design helps to unify the visual identity and further develop the optimal packages to increase the quality of the software we develop
-
-#NOTES:
-* You should replace all your dependencies into your custom names and files including:
-  * vendor namespace.
-  * composer information.
-  * logo
-  * credit and contributors links
-  * security email
-* To use this template, please click on button above "Use this template".  
-* Delete this section after you have finished developing your package
-
-# Package Name
-Your package description,Try to be briefly describing the features of the package,
-and if there are external resources for learning or explanation
+# Arabic Diff For Humans
+PHP Package to convert time difference to Arabic human readable string
 
 ##### 1 - Dependency
 The first step is using composer to install the package and automatically update your composer.json file, you can do this by running:
 
 ```shell
-composer require vendor_name/package_name
+composer require syrian-open-source/php-arabic-diff-for-human
 ```
 
-Features Or Usage
+Usage
 -----------
-Put the name of the feature and a link to this feature
-- [Any feature](https://github.com/syrian-open-source/php-package-template/blob/main/docs/feature.md#usage)
-
+Convert from string date, this feature will work to compare years, months,days,minutes, and seconds.
+You can pass the date as a string with any format.
+```php
+        $instance = (new ArabicDiffForHumans());
+        $time = "2018-1-1";
+        echo $instance->getFromDateString($time);
+        // the result should be: "منذ 4 سنين"
+```
+Convert from string date, this feature will work to compare years, months,days,minutes, and seconds.
+You can pass the date as a string with any format.
+```php
+        $instance = (new ArabicDiffForHumans());
+        $time = "2018-1-1";
+        echo $instance->get(strtotime($time));
+        // the result should be: "منذ 4 سنين"
+```
 
 Changelog
 ---------
-Please see the [CHANGELOG](https://github.com/syrian-open-source/php-package-template/blob/master/CHANGELOG.md) for more information about what has changed or updated or added recently.
+Please see the [CHANGELOG](https://github.com/syrian-open-source/php-arabic-diff-for-human/blob/master/CHANGELOG.md) for more information about what has changed or updated or added recently.
 
 Security
 --------
-If you discover any security related issues, please email them first to "your email", 
+If you discover any security related issues, please email them first to [[email protected]]([email protected]), 
 if we do not fix it within a short period of time please open a new issue describing your problem. 
 
 Credits
 -------
-* [your email](https://github.com/syrian-open-source/php-package-template/graphs/contributors)
-* [All contributors](https://github.com/syrian-open-source/php-package-template/graphs/contributors)
+* [your email](https://www.linkedin.com/in/abdussalam-alali/)
+* [All contributors](https://github.com/syrian-open-source/php-arabic-diff-for-human/graphs/contributors)