chore: bump version to 1.0.0; update changelog/readme

Cielquan · Nov 21, 2020 · 01d17e9 · 01d17e9
1 parent 17a2be1
commit 01d17e9
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 2 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -7,6 +7,19 @@ formelsammlung Change Log
 
 .. towncrier release notes start
 
+v1.0.0 (2020-11-21)
+-------------------
+
+Breaking Changes
+~~~~~~~~~~~~~~~~
+
+- Renamed ``tox_env_exe_runner`` to ``env_exe_runner`` adn added ``runner`` argument
+  on 2nd place, which takes either `tox` or `nox`. With this both runner are supported.
+
+
+----
+
+
 v0.4.0 (2020-11-14)
 -------------------
 

diff --git a/README.rst b/README.rst
@@ -33,7 +33,7 @@ Functionality
 - ``getenv_typed()``: is a wrapper around ``os.getenv`` returning the value of the environment variable in the correct python type.
 - ``calculate_string()``: takes an arithmetic expression as a string and calculates it.
 - ``SphinxDocServer``: is a flask plugin to serve the repository's docs build as HTML (by sphinx). Needs ``flask`` extra to be also installed to work.
-- ``tox_env_exe_runner()``: is a function to call a given ``tool`` from the first tox environments that has it installed in a list of tx environments.
+- ``env_exe_runner()``: is a function to call a given ``tool`` from the first tox/nox environments that has it installed in a list of tox/nox environments.
 
 
 Prerequisites

diff --git a/pyproject.toml b/pyproject.toml
@@ -6,7 +6,7 @@
 #: -- POETRY CONFIG --------------------------------------------------------------------
 [tool.poetry]
     name = "formelsammlung"
-    version = "0.4.0"
+    version = "1.0.0"
     description = "Collection of different functions"
     authors = ["Cielquan <[email protected]>"]
     license = "GPL-3.0-or-later"