Updates (#17)

* updates

* updating dependencies

Author: schmidtbri

.github/workflows/release.yml

@@ -27,7 +27,7 @@ jobs:
       env:
         SOURCE_TAG: ${{ github.event.release.tag_name }}
       run: |
-        echo "${SOURCE_TAG:1}" > ml_base/version.txt
+        echo -n "${SOURCE_TAG:1}" > ml_base/version.txt
 
     - name: "Build Package"
       run: make build

CHANGELOG.md

@@ -5,16 +5,29 @@ 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).
 
+## [0.2.1] - 2022-05-10
+
+## Fixed
+
+- Removed debugging statement from root of package.
+- Removed newline character from version string.
+
 ## [0.2.0] - 2022-02-16
+
 ### Added
+
 - MLModelDecorator base class.
 - Ability to add a decorator to a model in the ModelManager.
 
 ## [0.1.1] - 2021-01-17
+
 ### Fixed
+
 - Double initialization issue in ModelManager singleton class
 
 ## [0.1.0] - 2020-11-04
+
 ### Added
+
 - Base class "MLModel" for holding machine learning model prediction functionality
 - Class "ModelManager" for managing MLModel objects

README.md

@@ -1,14 +1,27 @@
-# ML Base Package
-Base classes and utilities that are useful for deploying ML models.
+![Code Quality Status](https://github.com/schmidtbri/ml-base/actions/workflows/test.yml/badge.svg)
+[![License](https://img.shields.io/badge/license-BSD--3--Clause-green)](https://opensource.org/licenses/BSD-3-Clause)
+[![PyPi](https://img.shields.io/badge/pypi-v0.2.1-green)](https://pypi.org/project/ml-base/)
 
-This package is useful for creating abstractions around machine learning models that make it easier to deploy them into 
-other software systems. 
+# ml-base
+
+**ml-base** is a package that provides base classes and utilities that are useful for deploying machine learning models.
 
 ## Installation 
 
-To download the code and set up a development use these instructions. 
+The easiest way to install ml-base is using pip
+
+```bash
+pip install ml-base
+```
+
+## Usage
 
-To download the source code execute this command:
+There are several examples of how to use the ml-base framework in the 
+[documentation](https://schmidtbri.github.io/ml-base/).
+
+## Development
+
+First, download the source code with this command:
 
 ```bash
 git clone https://github.com/schmidtbri/ml-base
@@ -31,8 +44,10 @@ Install the dependencies:
 make dependencies
 ```
 
-## Running the Unit Tests
+## Testing 
+
 To run the unit test suite execute these commands:
+
 ```bash
 # first install the test dependencies
 make test-dependencies
@@ -42,4 +57,4 @@ make test
 
 # clean up the unit tests
 make clean-test
-```
+```