update release instructions

BuildingSync · Nov 4, 2021 · c7a208c · c7a208c
1 parent ea06e16
commit c7a208c
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -5,6 +5,7 @@
 __pycache__
 *.egg-info
 *.pyc
+dist
 
 BuildingSync.xsd
 BuildingSync-*.xsd

diff --git a/README.md b/README.md
@@ -4,6 +4,10 @@
 
 Current BuildingSync version: `2.4.0`.
 
+## Installing
+
+`pip install bsyncpy`
+
 ## Generating
 - `poetry install`
 - `poetry run pre-commit install`
@@ -59,4 +63,13 @@ Check out our example Jupyter Notebook [here](https://nbviewer.jupyter.org/githu
 * Bump version in `pyproject.toml` file
 * Add CHANGELOG entry
 * Update (or add) generator test in `.github/ci.yml`
-* Update this README with the latest version of testing.
+* Update this README with the latest version of testing.
+
+## Releasing New Version
+
+* Merge everything down to `main`
+* `git tag <version>`. Version in the form of vX.Y.Z.
+* `git push --tags`.
+* Go to GitHub and convert the tag to a release.
+* `poetry build`
+* `poetry publish`. Login via pypi account.
diff --git a/pyproject.toml b/pyproject.toml
@@ -2,7 +2,7 @@
 name = "bsyncpy"
 version = "0.2.0"
 description = "Tools to autogenerate a Python SDK for BuildingSync given an XSD"
-authors = ["Joel Bender <[email protected]>"]
+authors = ["Joel Bender <[email protected]>", "Nicholas Long <[email protected]>"]
 
 [tool.poetry.dependencies]
 python = "^3.7.9"