workflow

.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: aso.mehmudi # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: aso.mehmudi # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/workflows/run-asosoft.yml

@@ -0,0 +1,34 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: asosoft
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python 
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+      - name: Run tests
+        run: python -m unittest
+      - name: Build package
+        run: python setup.py sdist bdist_wheel
+      - name: Upload artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: asosoft-dist
+          path: dist/*

README.md

@@ -7,6 +7,18 @@ AsoSoft Library is originally written in C# and this library is the Python port.
 - **Sort**: Sorts a list in correct Kurdish alphabet order.
 - **Poem Meter Classifier**: Classifies the meter of the input Kurdish poem 
 
+## How to use?
+- **Python version**: Python 3.11+ 
+- **Install package using pip**: [pip install asosoft](https://pypi.org/project/asosoft/)
+- **Import package in your py file**: 
+```python
+import asosoft
+```
+
+## Development
+AsoSoft Library is developed and maintained by Aso Mahmudi.
+AsoSoft Library is written in C# (.NET 6).
+
 ## Grapheme-to-Phoneme (G2P) converter and Transliteration
 This function is based on the study "[Automated Grapheme-to-Phoneme Conversion for Central Kurdish based on Optimality Theory](https://www.sciencedirect.com/science/article/abs/pii/S0885230821000292)". 
 
@@ -197,12 +209,4 @@ You can find Kurdish poems in https://books.vejin.net/.
 >>> classified = asosoft.ClassifyKurdishPoem(poem)
 >>> print("Poem Type= " + classified.overalMeterType)
 >>> print("Poem Meter= " + classified.overalPattern)
-```
-
-## How to use?
-Install [AsoSoft Library package](https://www.nuget.org/packages/AsoSoftLibrary) via NuGet Gallery.
-Then, insert `using AsoSoftLibrary;` into "Usings" of your codes.
-
-## Development
-AsoSoft Library is developed and maintained by Aso Mahmudi.
-AsoSoft Library is written in C# (.NET 6).
+```