adding release badge and changelog

Author: joe-mccarthy

CHANGELOG.md

@@ -0,0 +1,41 @@
+# 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.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Changed
+
+- Changelog typo
+
+## [1.0.0] - 2024-08-23
+
+### Added
+
+- Created the project changelog.
+- Created unit tests
+- Added module docstring
+- Added method docstring
+- Added badges
+- Get temperature, pressure, humidity from OpenWeatherMapAPI
+- Get temperature, pressure, humidity from BME280 sensor
+- Calculate the dew point for current readings
+- Check csv file exists
+- Creates missing csv file and creates headers
+- Appends current readings to the csv file
+- No API key assumes using BME280 sensor with defaults
+
+### Changed
+
+- Variables are passed as cli arguments
+- Updated the project readme
+
+### Removed
+
+- Removed hard coded variables
+
+[unreleased]: https://github.com/joe-mccarthy/environment-checker/compare/v1.1.1...HEAD
+[1.0.0]: https://github.com/joe-mccarthy/environment-checker/releases/tag/v0.0.1

README.md

@@ -1,8 +1,9 @@
 # Environment Checker
 
 ![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/joe-mccarthy/environment-checker/build-test.yml?style=for-the-badge)
-![Coveralls](https://img.shields.io/coverallsCoverage/github/joe-mccarthy/environment-checker?style=for-the-badge) 
+![Coveralls](https://img.shields.io/coverallsCoverage/github/joe-mccarthy/environment-checker?style=for-the-badge)
 [![Python 3.8](https://img.shields.io/badge/python-3.8-blue.svg?style=for-the-badge)](https://www.python.org/downloads/release/python-380/)
+![GitHub Release](https://img.shields.io/github/v/release/joe-mccarthy/environment-checker?sort=semver&style=for-the-badge)
 ![GitHub License](https://img.shields.io/github/license/joe-mccarthy/environment-checker?style=for-the-badge)
 
 Simple script that's called from a cron job that will take a reading from a bme 280 sensor or open weather api and record the result in a csv file with the calculated dew point.