Merge pull request #5 from grobbles/bugfix/fix_release_pipeline

fix release pipeline

.github/workflows/release.yml

@@ -1,10 +1,9 @@
-name: CI / CD
+name: CI/CD Release
 
 on:
   push:
-    branches:
-      - main
-      - release
+    tags:
+    - 'v[0-9]+.[0-9]+.[0-9]+'
 
 jobs:
   build-and-publish:
@@ -65,7 +64,6 @@ jobs:
           skip_existing: true
 
       - name: Publish distribution 📦 to PyPI
-        if: startsWith(github.ref, 'refs/tags')
         uses: pypa/gh-action-pypi-publish@master
         with:
           password: ${{ secrets.PYPI_API_TOKEN }}

.github/workflows/test.yml

@@ -1,4 +1,4 @@
-name: CI / CD
+name: CI/CD Test
 
 on: [ push, pull_request ]
 

README.md

@@ -1,5 +1,30 @@
 # Smart Signals
 
-![Build](https://github.com/grobbles/SmartSignals/actions/workflows/build.yml/badge.svg)
+![Build](https://github.com/grobbles/SmartSignals/actions/workflows/test.yml/badge.svg)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![codecov](https://codecov.io/gh/grobbles/SmartSignals/branch/main/graph/badge.svg?token=GAHKYKS1SD)](https://codecov.io/gh/grobbles/SmartSignals)
+[![codecov](https://codecov.io/gh/grobbles/SmartSignals/branch/main/graph/badge.svg?token=GAHKYKS1SD)](https://codecov.io/gh/grobbles/SmartSignals)
+
+# Install 
+
+You can install this package with pip from PyPi.
+
+````bash
+pip install SmartSignals
+````
+
+# Usage
+
+````python
+from smart_signals import *
+
+class Test:
+    @SmartSignalSlot(str)
+    def slot(self, message: str):
+        print(message)
+        pass
+
+test = Test()
+signal = SmartSignal(str)
+signal.connect(test.slot)
+signal.emit("message")
+````