Readme

CHANGELOG.md

@@ -7,9 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ## [Unreleased]
 ## [0.1] - 2025-xx-xx
 ### Added
-- Item1
-- Item2
-- Item3
+- `get_events` function
+- Jalali events
+- Gregorian events
+- Hijri events
 
 
 [Unreleased]: https://github.com/openscilab/rokh/compare/v0.1...dev

README.md

@@ -1,5 +1,4 @@
 <div align="center">
-    <img src="https://github.com/openscilab/rokh/raw/main/otherfiles/logo.png" alt="Rokh Logo" width="220">
     <h1>Rokh: Iranian Calendar Events Collection</h1>
     <br/>
     <a href="https://badge.fury.io/py/rokh"><img src="https://badge.fury.io/py/rokh.svg" alt="PyPI version"></a>
@@ -16,7 +15,7 @@
 Rokh provides a unified interface for accessing Iranian calendar events across Jalali, Gregorian, and Hijri date systems. It lets you easily retrieve national holidays, cultural events, and religious occasions by simply passing a date. It automatically converts between calendars and return event's description.
 You can use it in your apps, bots, and research tools that rely on Iranian date conversions, holidays, and cultural event data.
 
-In Farsi, Rokh is derived from Rokhdad, meaning "event." Rokh itself also means “face” and even refers to the "rook" piece in chess.
+In Farsi, Rokh is derived from Rokhdad, meaning "event." Rokh itself also means "face" and even refers to the "rook" piece in chess.
 
 </p>
 
@@ -51,7 +50,7 @@ In Farsi, Rokh is derived from Rokhdad, meaning "event." Rokh itself also means
         </td>
         <td align="center">
             <img src="https://github.com/openscilab/rokh/actions/workflows/test.yml/badge.svg?branch=dev">
-            </td>
+        </td>
     </tr>
 </table>
 
@@ -105,6 +104,12 @@ Just fill an issue and describe it. We'll check it ASAP! or send an email to [ro
 - Please complete the issue template
 
 
+## References
+
+<blockquote>1- <a href="https://www.time.ir/">ساعت و تقویم ایران | تاریخ امروز | Time.ir</a></blockquote>
+<blockquote>2- <a href="https://holidayapi.ir/">Jalali Holiday API</a></blockquote>
+
+
 ## Show your support
 
 

setup.py

@@ -33,14 +33,14 @@ def read_description() -> str:
     name='rokh',
     packages=['rokh', 'rokh.events'],
     version='0.1',
-    description="Rokh provides a unified interface for accessing Iranian calendar events across Jalali, Gregorian, and Hijri date systems. It lets you easily retrieve national holidays, cultural events, and religious occasions by simply passing a date. It automatically converts between calendars and return event's description. You can use it in your apps, bots, and research tools that rely on Iranian date conversions, holidays, and cultural event data. In Farsi, Rokh is derived from Rokhdad, meaning \"event.\" Rokh itself also means “face” and even refers to the \"rook\" piece in chess.",
+    description="Rokh: Iranian Calendar Events Collection",
     long_description=read_description(),
     long_description_content_type='text/markdown',
     author='Rokh Development Team',
     author_email='rokh@openscilab.com',
     url='https://github.com/openscilab/rokh',
     download_url='https://github.com/openscilab/rokh/tarball/v0.1',
-    keywords="events date date-system",
+    keywords="events date date-system calendar gregorian hijri jalali",
     project_urls={
             'Source': 'https://github.com/openscilab/rokh',
     },
@@ -49,6 +49,7 @@ def read_description() -> str:
     classifiers=[
         'Development Status :: 2 - Pre-Alpha',
         'Natural Language :: English',
+        'Natural Language :: Persian',
         'License :: OSI Approved :: MIT License',
         'Operating System :: OS Independent',
         'Programming Language :: Python :: 3.7',
@@ -64,6 +65,8 @@ def read_description() -> str:
         'Intended Audience :: End Users/Desktop',
         'Intended Audience :: Manufacturing',
         'Topic :: Education',
+        'Topic :: Office/Business :: Scheduling',
+        'Topic :: Utilities',
     ],
     license='MIT',
 )