From e50f881bbe79aa308d6b10c4af6cb02fc8756344 Mon Sep 17 00:00:00 2001
From: Sepand Haghighi <sepand.haghighi@yahoo.com>
Date: Tue, 13 Feb 2024 22:08:05 +0330
Subject: [PATCH] Minor edits (#38)

* doc : RELEASE.md updated

* fix : dependabot.yml config added

* doc : Engine section added to README.md

* doc : Engine section updated

* doc : CHANGELOG.md updated

* doc : README.md badges section bug fixed
---
 .github/dependabot.yml | 11 +++++++++++
 CHANGELOG.md           |  1 +
 README.md              | 40 ++++++++++++++++++++++++++++++++++------
 others/RELEASE.md      |  4 ++--
 4 files changed, 48 insertions(+), 8 deletions(-)
 create mode 100644 .github/dependabot.yml

diff --git a/.github/dependabot.yml b/.github/dependabot.yml
new file mode 100644
index 0000000..811b9c4
--- /dev/null
+++ b/.github/dependabot.yml
@@ -0,0 +1,11 @@
+version: 2
+updates:
+- package-ecosystem: pip
+  directory: "/"
+  schedule:
+    interval: weekly
+    time: "01:30"
+  open-pull-requests-limit: 10
+  target-branch: dev
+  assignees:
+      - "sadrasabouri"
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 24c9c5c..8d81ea4 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Bug report template modified
 - `NavaThread.stop` method bug fixed
 - Test system modified
+- `README.md` modified 
 ## [0.3] - 2024-01-31
 ### Added
 - `NavaThread` class
diff --git a/README.md b/README.md
index 2251a1a..b4ba0f6 100644
--- a/README.md
+++ b/README.md
@@ -20,6 +20,7 @@
    * [Overview](https://github.com/openscilab/nava#overview)
    * [Installation](https://github.com/openscilab/nava#installation)
    * [Usage](https://github.com/openscilab/nava#usage)
+   * [Engine](https://github.com/openscilab/nava#engine)
    * [Issues & Bug Reports](https://github.com/openscilab/nava#issues--bug-reports)
    * [Contribution](https://github.com/openscilab/nava/blob/main/.github/CONTRIBUTING.md)
    * [Authors](https://github.com/openscilab/nava/blob/main/AUTHORS.md)
@@ -63,18 +64,18 @@ Nava is a Python library that allows users to play sound in Python without any d
 	</tr>
     <tr>
 		<td align="center">Linux CI</td>
-		<td align="center"><img src="https://github.com/openscilab/nava/workflows/Linux/badge.svg?branch=main"></td>
-		<td align="center"><img src="https://github.com/openscilab/nava/workflows/Linux/badge.svg?branch=dev"></td>
+		<td align="center"><img src="https://github.com/openscilab/nava/actions/workflows/linux_test.yml/badge.svg?branch=main"></td>
+		<td align="center"><img src="https://github.com/openscilab/nava/actions/workflows/linux_test.yml/badge.svg?branch=dev"></td>
 	</tr>
 	<tr>
 		<td align="center">Windows CI</td>
-		<td align="center"><img src="https://github.com/openscilab/nava/workflows/Windows/badge.svg?branch=main"></td>
-		<td align="center"><img src="https://github.com/openscilab/nava/workflows/Windows/badge.svg?branch=dev"></td>
+		<td align="center"><img src="https://github.com/openscilab/nava/actions/workflows/windows_test.yml/badge.svg?branch=main"></td>
+		<td align="center"><img src="https://github.com/openscilab/nava/actions/workflows/windows_test.yml/badge.svg?branch=dev"></td>
 	</tr>
 	<tr>
 		<td align="center">macOS CI</td>
-		<td align="center"><img src="https://github.com/openscilab/nava/workflows/macOS/badge.svg?branch=main"></td>
-		<td align="center"><img src="https://github.com/openscilab/nava/workflows/macOS/badge.svg?branch=dev"></td>
+		<td align="center"><img src="https://github.com/openscilab/nava/actions/workflows/macOS_test.yml/badge.svg?branch=main"></td>
+		<td align="center"><img src="https://github.com/openscilab/nava/actions/workflows/macOS_test.yml/badge.svg?branch=dev"></td>
 	</tr>
 </table>
 
@@ -136,6 +137,33 @@ except NavaBaseError as e:
     print(str(e))
 ```
 
+## Engine
+
+List of different platforms and the corresponding engines that are used for sound playing.
+
+<table>
+	<tr> 
+		<th align="center">Platform</th>
+		<th align="center">Engine</th>
+		<th align="center">Supported Formats</th>
+	</tr>
+    <tr>
+		<td align="center">Linux</td>
+		<td align="center"><a href="https://www.alsa-project.org/wiki/Main_Page">Advanced Linux Sound Architecture</a></td>
+		<td align="center"><code>.wav</code></td>
+	</tr>
+    <tr>
+		<td align="center">Windows</td>
+		<td align="center"><a href="https://docs.python.org/3/library/winsound.html">Winsound</a></td>
+		<td align="center"><code>.wav</code></td>
+	</tr>
+    <tr>
+		<td align="center">macOS</td>
+		<td align="center"><a href="https://ss64.com/mac/afplay.html">Audio File Play</a></td>
+		<td align="center"><code>.wav</code>,<code>.mp3</code></td>
+	</tr>
+</table>
+
 
 ## Issues & bug reports
 
diff --git a/others/RELEASE.md b/others/RELEASE.md
index 60ce2bb..fe8efee 100644
--- a/others/RELEASE.md
+++ b/others/RELEASE.md
@@ -1,7 +1,7 @@
 
 # Nava Release Instructions
 
-#### Last Update: 2024-02-06
+#### Last Update: 2024-02-12
 
 1. Create the `release` branch under `dev`
 2. Update all version tags
@@ -21,7 +21,7 @@
 	5. Wait for all CI pass
 	6. Need review
 6. Merge `dev` branch into `main`
-	1. Checkout to `main`
+	1. `git checkout main`
 	2. `git merge dev`
 	3. `git push origin main`
 	4. Wait for all CI pass