Merge pull request #7 from leagueutils/release/1.1.0

chore: version bumps & release docs

CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+This page contains a fairly detailed, fairly complete, fairly readable summary of what changed with each version of the
+library.
+
+## v1.1.0
+This release adds:
+- an execution limit for triggers. By specifying the `max_trigger_count` parameter, a trigger can be instructed to
+  terminate after a certain number of executions.
+- a way to dynamically terminate trigger execution from within the decorated function. By raising
+ `triggers.StopRunning()`, the containing trigger will be instructed to exit after finishing the current iteration.
+- a `ScheduledTrigger` class that allows triggers to run on one or more predefined dates.
+- a  programmatic interface (`triggers.apply_trigger()`) to schedule triggers at runtime
+
+## v1.0.0
+Initial spin-off from [coc.py](https://github.com/mathsman5133/coc.py). Already comes with an `IntervalTrigger` and a
+`CronTrigger`, error handling, logging and a framework for extension.

README.md

@@ -5,6 +5,10 @@ This library originated as an extension for [coc.py](https://github.com/mathsman
 off into a standalone lib because I want to use the scheduling capabilities without adding a bunch of other
 dependencies to my projects.
 
+## Changelog
+A human-readable, fairly detailed changelog can be found
+[here](https://github.com/leagueutils/async-triggers/blob/develop/CHANGELOG.md).
+
 ## Overview
 
 Repetition and scheduling are incredibly important, but often enough, you'll find yourself needing to do some simple

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "triggers"
-version = "1.0.0"
+version = "1.1.0"
 description = ""
 authors = ["lukasthaler <33826427+lukasthaler@users.noreply.github.com>"]
 readme = "README.md"

triggers/__init__.py

@@ -1,5 +1,7 @@
 """A library that provides decorators to facilitate automated, periodic repetition of functions."""
 
+__version__ = '1.1.0'
+
 import types
 
 from .cron import CronParserError, CronSchedule