workflows + release (#2)

* fix workflows, update changelog, add badges

* add install / warning

* fix format

.github/workflows/pre-release.yml

@@ -7,7 +7,7 @@ jobs:
   pypi-publish:
     name: Build pre-release dist & upload to PyPI
     runs-on: ubuntu-latest
-    environment: publish
+    environment: release
     steps:
       - uses: actions/checkout@v4
         with:

.github/workflows/publish.yaml → .github/workflows/release.yml

@@ -9,7 +9,7 @@ jobs:
   pypi-publish:
     name: Build dist & upload to PyPI
     runs-on: ubuntu-latest
-    environment: publish
+    environment: release
     steps:
       - uses: actions/checkout@v4
         with:

CHANGELOG.md

@@ -24,4 +24,10 @@ Types of changes:
 
 ### Fixed
 
-### Dependencies
+### Dependencies
+
+## [0.0.0] - 2024-10-04
+
+### Added
+- Setup basic project/repo template ([#1](https://github.com/qBraid/pyqasm/pull/1))
+- Configured PyPI workflows ([#2](https://github.com/qBraid/pyqasm/pull/2))

README.md

@@ -1,3 +1,20 @@
 # pyqasm
 
-Python toolkit providing an OpenQASM 3 semantic analyzer and utilities for program analysis and compilation.
+[![PyPI version](https://img.shields.io/pypi/v/pyqasm.svg?color=blue)](https://pypi.org/project/pyqasm/)
+[![Python verions](https://img.shields.io/pypi/pyversions/pyqasm.svg?color=blue)](https://pypi.org/project/pyqasm/)
+[![GitHub](https://img.shields.io/badge/issue_tracking-github-black?logo=github)](https://github.com/qBraid/pyqasm/issues)
+[![License](https://img.shields.io/github/license/qBraid/pyqasm.svg?color=purple)](https://www.gnu.org/licenses/gpl-3.0.html)
+[![QCSE](https://img.shields.io/badge/QCSE-pyqasm-orange?logo=stackexchange)](https://quantumcomputing.stackexchange.com/questions/tagged/pyqasm)
+
+Python toolkit providing an OpenQASM 3 semantic analyzer and utilities for program analysis and compilation.
+
+## Installation
+
+pyqasm requires Python 3.10 or greater, and can be installed with pip as follows:
+
+```bash
+pip install pyqasm
+```
+
+>[!WARNING]
+> **This project is "pre-alpha", and is not yet stable or fully realized. Use with caution, as the API and functionality are subject to significant changes.**