From 41da6903bc35e1388d23dc57a66252becbd33c41 Mon Sep 17 00:00:00 2001 From: Tim O'Donnell Date: Sat, 6 Mar 2021 13:43:27 -0500 Subject: [PATCH] update readme --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index d247346..ed8ba95 100644 --- a/README.md +++ b/README.md @@ -176,3 +176,14 @@ $ phipkit-plot-antigens blast.reference.csv hits.csv antigens.csv --out antigens Example results: [antigens.pdf](example-data/antigens.pdf). +## Contributing +PRs with bugfixes or new functionality are welcome. Before embarking on a major +change, please file an issue. + +To push a new release to PyPI: +* Make sure the package version specified in [`__init__.py`](https://github.com/timodonnell/yabul/blob/main/yabul/__init__.py) +is a new version greater than what's on [PyPI](https://pypi.org/project/yabul/). +* Tag a new release on GitHub matching this version + +Travis should deploy the release to PyPI automatically. +