Merge branch 'develop' of https://github.com/building-physics/airflownetwork-python into develop

Author: jasondegraw

.github/workflows/python-publish.yml

@@ -0,0 +1,39 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    - name: Build package
+      run: python -m build
+    - name: Publish package
+      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}

README.md

@@ -1,4 +1,4 @@
-# airflownetwork
+# AirflowNetwork
 
 [![PyPI - Version](https://img.shields.io/pypi/v/airflownetwork.svg)](https://pypi.org/project/airflownetwork)
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/airflownetwork.svg)](https://pypi.org/project/airflownetwork)
@@ -7,9 +7,35 @@
 
 **Table of Contents**
 
+- [About](#about)
 - [Installation](#installation)
 - [License](#license)
 
+## About
+This is a small library of functions and classes to examine EnergyPlus AirflowNetwork models. A driver program is provided to analyze models in the epJSON format. To summarize the model contents:
+
+```
+airflownetwork summarize my_model.epJSON
+```
+
+To create a graph of the model in the DOT format:
+
+```
+airflownetwork graph my_model.epJSON
+```
+
+To generate an audit of the model:
+
+```
+airflownetwork audit my_model.epJSON
+```
+
+Further help is available on the command line:
+
+```
+airflownetwork --help
+```
+
 ## Installation
 
 ```console