From 9e29acda597461239956102121f54dd33cab9192 Mon Sep 17 00:00:00 2001
From: Naresh Kumar D <susrisha@gmail.com>
Date: Thu, 20 Mar 2025 17:00:40 +0530
Subject: [PATCH] Update README.md

- Added deployment and local usage notes
---
 README.md | 23 ++++++++++++++++++++++-
 1 file changed, 22 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 077ddcf..e2e50e7 100644
--- a/README.md
+++ b/README.md
@@ -106,4 +106,25 @@ test_remove_extracted_files (test_zipfile_handler.TestZipFileHandler) ... ok
 Ran 37 tests in 1284.068s
 
 OK
-```
\ No newline at end of file
+```
+
+## Use locally:
+To use the library locally, use the [example.py](./src/example.py) code
+
+## Deployment:
+
+- The library can be pushed to [TestPy](https://test.pypi.org/project/python-osw-validation/) or [PYPI](https://pypi.org/project/python-osw-validation/)
+### Deploy to TestPy
+- On every push to `dev` branch, a workflow is triggered which publishes the updated version to TestPy
+
+### Deploy to PyPI
+- This happens whenever a tag/release is created with `*.*.*` notation (eg. 0.0.8)
+- To change the version, change the version at [version.py](./src/python_osw_validation/version.py)
+- To release a new version:
+  - Go to Github link of this repository
+  - Under [releases](https://github.com/TaskarCenterAtUW/TDEI-python-lib-osw-validation/releases), click on `Draft a new release`
+  - Under `choose a new tag`, add a new tag `v*.*.*` , Generate Release notes
+  - Choose `main` branch for release
+  - Publish the release.
+- This release triggers a workflow to generate the new version of the Package.
+- The new package will be available at https://pypi.org/project/python-osw-validation/
\ No newline at end of file