diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 24679648..804e4eee 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -12,6 +12,16 @@ Unreleased ---- +0.34.1 (2024-02-10) +------------------- + +Added +^^^^^ + +* Updated the readme to reflect completion of the PyOpenSci review. + +---- + 0.34.0 (2024-02-04) ------------------- diff --git a/README.rst b/README.rst index ff8c4856..43428c8a 100644 --- a/README.rst +++ b/README.rst @@ -1,6 +1,9 @@ .. image:: https://www.repostatus.org/badges/latest/wip.svg :target: https://www.repostatus.org/#wip :alt: Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public. +.. image:: https://tinyurl.com/y22nb8up + :target: https://github.com/pyOpenSci/software-review/issues/121 + :alt: pyOpenSci .. image:: https://img.shields.io/readthedocs/sciform?logo=readthedocs&link=https%3A%2F%2Fsciform.readthedocs.io%2Fen%2Fstable%2F :target: https://sciform.readthedocs.io/en/stable/ :alt: Read the Docs @@ -61,38 +64,6 @@ or install the latest development version from ``sciform`` is compatible with Python versions >=3.9. -================== -Under Construction -================== - -``sciform`` adheres to `semantic versioning `_. -The major version for ``sciform`` is still ``0`` indicating that -``sciform`` is still in the development stage which means there may be -backwards-incompatible changes to the interface (e.g. function or object -behaviors and names) without a corresponding major version bump. -All changes are announced after new releases in the -`changelog `_. -Backwards incompatible changes are indicated with the **[BREAKING]** -flag. - -We are very excited to get your feedback to help stabilize the interface -and make ``sciform`` a more useful tool. -You can provide your feedback on your experience with ``sciform`` by -filling out -`the user experience survey `_. -Now is a great time to share your ``sciform`` ideas or issues by -opening a -`discussion `_ or -`issue `_. -If you would like to contribute to ``sciform`` then please see -`How to Contribute `_. - -``sciform`` is currently undergoing -`peer review `_ -by the `PyOpenSci `_ community. -You can view the on-going review -`here `_. - ===== Usage ===== @@ -159,6 +130,39 @@ for more details and `Examples `_ for more examples. +============== +Project Status +============== + +``sciform`` adheres to `semantic versioning `_. +The major version for ``sciform`` is still ``0`` indicating that +``sciform`` is still in the development stage which means there may be +backwards-incompatible changes to the interface (e.g. function or object +behaviors and names) without a corresponding major version bump. +All changes are announced after new releases in the +`changelog `_. +Backwards incompatible changes are indicated with the **[BREAKING]** +flag. + +We are very excited to get your feedback to help stabilize the interface +and make ``sciform`` a more useful tool. +You can provide your feedback on your experience with ``sciform`` by +filling out +`the user experience survey `_. +Now is a great time to share your ``sciform`` ideas or issues by +opening a +`discussion `_ or +`issue `_. +If you would like to contribute to ``sciform`` then please see +`How to Contribute `_. + +``sciform`` has undergone +`peer review `_ +by the `PyOpenSci `_ community and been +accepted into the PyOpenSci ecosystem. +You can view the review +`here `_. + ================ Acknowledgements ================