aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorItay Grudev <itay@grudev.com>2016-07-04 23:17:23 +0100
committerItay Grudev <itay@grudev.com>2016-07-04 23:17:23 +0100
commit760bf81d25775301014f7fecd3d07dedf34b87b2 (patch)
tree9ca68a37872027394c2c38991ab8648b6d5a4208
parentUpdated license dates. Explicit license statement in the header and source files (diff)
downloadsingleapplication-760bf81d25775301014f7fecd3d07dedf34b87b2.tar.xz
Added CHANGELOG and version description
-rw-r--r--CHANGELOG.md41
-rw-r--r--README.md9
2 files changed, 50 insertions, 0 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..74503aa
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,41 @@
+Changelog
+=========
+
+__v2.4__
+--------
+
+* Stability improvements
+* Support for secondary instances.
+* The library now recovers safely after the primary process has crashed
+ and the shared memory had not been deleted.
+
+__v2.3__
+--------
+
+* Improved pimpl design and inheritance safety.
+
+ _Vladislav Pyatnichenko_
+
+__v2.2__
+--------
+
+* The `QAPPLICATION_CLASS` macro can now be defined in the file including the
+Single Application header or with a `DEFINES+=` statement in the project file.
+
+__v2.1__
+--------
+
+* A race condition can no longer occur when starting two processes nearly
+ simultaneously.
+
+ Fix issue [#3](https://github.com/itay-grudev/SingleApplication/issues/3)
+
+__v2.0__
+--------
+
+* SingleApplication is now being passed a reference to `argc` instead of a
+ copy.
+
+ Fix issue [#1](https://github.com/itay-grudev/SingleApplication/issues/1)
+
+* Improved documentation.
diff --git a/README.md b/README.md
index 27e5176..b018022 100644
--- a/README.md
+++ b/README.md
@@ -106,6 +106,15 @@ will replace it as Primary even if the `--secondary` argument has been set.
*P.S. If you think this behavior could be improved create an issue and explain
why.*
+Versioning
+----------
+
+The current library versions is `2.4`.
+Each major version introduces either very significant changes or is not
+backwards compatible with the previous version. Minor versions only add
+additional features, bug fixes or performance improvements and are backwards
+compatible with the previous release.
+
Implementation
--------------