Skip to content

Commit

Permalink
Updated CHANGELOG to reflect v1.0.0 (#5)
Browse files Browse the repository at this point in the history
  • Loading branch information
ianmkenney authored Oct 25, 2023
1 parent 60871f3 commit 00e7bfb
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,11 @@ The rules for this file:

### Authors
<!-- GitHub usernames of contributors to this release -->
- ianmkenney

### Added
<!-- New added features -->
- GitHub action workflow for automatic PyPI package deployment (PR #3)

### Fixed
<!-- Bug fixes -->
Expand All @@ -35,3 +37,23 @@ The rules for this file:

### Removed
<!-- Removed features -->

## [1.0.0] -- 2023-10-10

The original `MDAnalysis.analysis.psa` was written by Sean Seyler in 2015
and had been part of MDAnalysis since release 0.10.0,
https://docs.mdanalysis.org/2.6.1/documentation_pages/analysis/psa.html.
Ian Kenney created the `pathsimanalysis` MDAKit in 2023, based on the original
code in MDAnalysis. Additional contributors to the original source code are
listed in the AUTHORS.md file.

### Added

- the core functionality of PathSimAnalysis (and its tests) was implemented
using the source code from MDAnalysis.analysis.psa
- PRs trigger Read the Docs for debugging documentation (PR #1)
- GitHub actions workflow for building and deploying docs to GitHub pages
(PR #2)

[Unreleased]: https://github.com/MDAnalysis/PathSimAnalysis/compare/1.0.0...HEAD
[1.0.0]: https://github.com/MDAnalysis/PathSimAnalysis/releases/tag/1.0.0

0 comments on commit 00e7bfb

Please sign in to comment.