release v0.1.0

CHANGELOG.md

@@ -0,0 +1,23 @@
+# 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).
+
+## [Unreleased]
+
+## [0.1.0] - 2020-09-02
+### Added
+- `CC1101` class providing
+  - context manager to open SPI port
+  - `transmit()` for buffered transmission
+  - context manager `asynchronous_transmission()` for manual signal generation
+  - `get_configuration_register_values()` to read all configuration registers
+- OOK modulation
+- configurable symbol rate & sync mode
+- optional manchester encoding
+- disabled data whitening
+- automatic calibration
+
+[Unreleased]: https://github.com/fphammerle/python-cc1101/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/fphammerle/python-cc1101/releases/tag/v0.1.0

README.md

@@ -4,7 +4,7 @@
 [![Last Release](https://img.shields.io/pypi/v/cc1101.svg)](https://pypi.org/project/cc1101/#history)
 [![Compatible Python Versions](https://img.shields.io/pypi/pyversions/cc1101.svg)](https://pypi.org/project/cc1101/)
 
-Python Library for [CC1101 Transceivers](https://www.ti.com/product/CC1101)
+Python Library to Transmit RF Signals via [CC1101 Transceivers](https://www.ti.com/product/CC1101)
 
 ## Setup
 
@@ -51,3 +51,5 @@ In case a `PermissionError` gets raised,
 check the permissions of `/dev/spidev*`.
 You'll probably need `sudo usermod -a -G spi $USER`,
 followed by a re-login.
+
+CC1101's docs: https://www.ti.com/lit/ds/symlink/cc1101.pdf