add changelog

and add links to changelog in docs and readme

CHANGELOG.md

@@ -0,0 +1,73 @@
+# Python-seabreeze changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+| label  | description                         |
+|-------:|:------------------------------------|
+| *doc*  | module documentation related        |
+| *csb*  | refers to `seabreeze.cseabreeze`    |
+| *psb*  | refers to `seabreeze.pyseabreeze`   |
+| *spec* | refers to `seabreeze.spectrometers` |
+
+
+## [Unreleased]
+
+## [1.0.0rc4] - 2017-09-07
+### Added
+- added this changelog
+
+### Fixed
+- *psb* fix `trigger_mode` for Spark
+- *psb* fix `OBPProtocol` implementation for py3
+- *psb* py2/py3 compatibility fix when reading serial number
+- `seabreeze.backend` fix regression with error logging
+- fixed test suites if backend not installed or not available on ci
+
+## [1.0.0rc3] - 2017-09-04
+### Added
+- *docs* added note regarding pip install for prereleases
+
+### Fixed
+- *csb* fix wheels for OSX
+- `seabreeze_os_setup` fix elevating to admin shell
+- `seabreeze_os_setup` fix download of drivers on py27
+
+## [1.0.0rc2] - 2017-09-01
+### Added
+- *docs* extensive documentation via sphinx on [readthedocs](https://python-seabreeze.readthedocs.io)
+- `seabreeze_os_setup` entry point for doing udev rule (linux) and driver setup (windows)
+- tests for basic module functionality and potentially connected spectrometers
+
+### Changed
+- complete rewrite of the backend interfaces
+- *psb* refactored to be more easily extendable
+- *csb* now wrapping the cpp interface of libseabreeze and exposing ALL features
+
+## [0.6.0] - 2017-05-18
+### Added
+- initial docs for backends and public api
+- install instructions for linux, osx and windows
+- seabreeze.cseabreeze add spectrum_processing feature
+
+### Fixed
+- `seabreeze.backends` fix Exception.message deprecated
+- *psb* fix nonlinearity\_coeffs feature if 0 coefficients defined
+
+### Changed
+- *csb* recompiled wrapper with newer cython
+
+## [0.5.3] - 2016-02-16
+### Added
+- oldest version I'll go back to in this changelog
+
+### Changed
+- Don't require numpy during build of cseabreeze cython extension
+
+[Unreleased]: https://github.com/olivierlacan/keep-a-changelog/compare/v1.0.0rc4...HEAD
+[1.0.0rc4]: https://github.com/olivierlacan/keep-a-changelog/compare/v1.0.0rc3...v1.0.0rc4
+[1.0.0rc3]: https://github.com/olivierlacan/keep-a-changelog/compare/v1.0.0rc2...v1.0.0rc3
+[1.0.0rc2]: https://github.com/olivierlacan/keep-a-changelog/compare/python-seabreeze-v0.6.0...v1.0.0rc2
+[0.6.0]: https://github.com/olivierlacan/keep-a-changelog/compare/python-seabreeze-v0.5.3...python-seabreeze-v0.6.0
+[0.5.3]: https://github.com/ap--/python-seabreeze/tree/python-seabreeze-v0.5.3

README.md

@@ -19,6 +19,9 @@ SeaBreeze is not available it can fallback to a pyUSB based reimplementation.
 
 You'll find the documentation here [https://python-seabreeze.readthedocs.io/en/latest/](https://python-seabreeze.readthedocs.io/en/latest/)
 
+## Changes
+
+The changelog can be found here [CHANGELOG.md](https://github.com/ap--/python-seabreeze/blob/master/CHANGELOG.md)
 
 ## Usage
 

docs/source/index.rst

@@ -17,6 +17,7 @@ based reimplementation.
 It's recommended to read the :ref:`Installing python-seabreeze section <install-seabreeze>`,
 the :ref:`Quickstart Guide <quickstart>` and the :ref:`API documentation <api>`. Also check
 out the :ref:`Contributing Guide <contrib>` if you want to learn how to contribute to the project.
+A changelog is available `here <https://github.com/ap--/python-seabreeze/blob/master/CHANGELOG.md>`_.
 
 
 .. figure:: _static/overview.png