Update Documentation (#12)

* docs: rename authors surname

* refactor: rename error for usage clarity, add more detailed error description

* refactor: append to last commit

* docs: update documentation to most public methods for better understanding and usage

* docs: minor text changes in readme

* chore: add CHANGELOG.md

Author: mflknr

CHANGELOG.md

@@ -0,0 +1,33 @@
+# 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).
+
+## [1.0.3] - 2021-07-22
+
+### Added
+
+- `CHANGELOG.md` for a better overview regarding all releases.
+- Localized error description to error type for more clarity.
+
+### Changed
+
+- Renamed `Error` to `VersionValidationError` for better understanding when parsing an invalid string.
+- Updated and enhanced documentation on public methods and properties.
+
+## [1.0.2] - 2021-03-30
+
+Fixed regex pattern for checking if string is alpha numeric or numeric. Removed minor typos and updated documentation.
+
+## [1.0.1] - 2021-03-30
+
+Added missing documentation. Removed redundant methods.
+
+## [1.0.0] - 2021-03-30
+
+Create a version object using a string or from component building a semantic version! You can also use the SemanticVersionComparable protocol to compare to version as much as you like or implement your own version object.
+
+## [0.6.0] - 2021-01-07
+
+Initial published setup of this package. Create a version from string, using major, minor, patch and extensions, from Bundle or from ProcessInfo. Compare two versions with common operators (==, ===, <, <=, >, >=) or get the severity of an update.

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Marius Hötten-Löns
+Copyright (c) 2021 Marius Felkner
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -6,7 +6,7 @@
 [![doccov](https://mflknr.github.io/SwiftVersionCompare/badge.svg?sanitize=true)](https://mflknr.github.io/SwiftVersionCompare/)
 [![codecov](https://codecov.io/gh/mflknr/SwiftVersionCompare/branch/develop/graph/badge.svg?token=6EAG2J8DMU)](https://codecov.io/gh/mflknr/SwiftVersionCompare)
 
-A small package introducing a `Version` object implementing the  `SemanticVersionComparable` protocol for comparing versions conforming to [SemVer](https://semver.org). 
+A package introducing a `Version` object implementing the  `SemanticVersionComparable` protocol for comparing versions conforming to [SemVer](https://semver.org). 
 
 # Installation
 

Sources/SwiftVersionCompare/Helper/Character+Extensions.swift

@@ -2,7 +2,7 @@
 //  Character+Extensions.swift
 //  SwiftVersionCompare
 //
-//  Created by Marius Hötten-Löns on 30.03.21.
+//  Created by Marius Felkner on 30.03.21.
 //
 
 internal extension Character {

Sources/SwiftVersionCompare/Helper/Error.swift

@@ -2,7 +2,7 @@
 //  String+Regex.swift
 //  SwiftVersionCompare
 //
-//  Created by Marius Hötten-Löns on 05.01.21.
+//  Created by Marius Felkner on 05.01.21.
 //
 
 internal extension String {

Sources/SwiftVersionCompare/Helper/String+Regex.swift

@@ -1,14 +1,13 @@
 //
-//  ComparisonResult.swift
+//  VersionCompareResult.swift
 //  SwiftVersionCompare
 //
-//  Created by Marius Hötten-Löns on 06.01.21.
+//  Created by Marius Felkner on 06.01.21.
 //
 
 /// The severity of an update between versions.
 ///
-/// - Note: A difference between build-meta-data of versions are explicitly ignored, since `SemVer`  does not considere
-///         them to be different ranks.
+/// - Note: A difference between build-meta-data of versions are as `SemVer` states explicitly ignored.
 public enum VersionCompareResult {
     /// A `MAJOR`update
     case major

Sources/SwiftVersionCompare/Helper/VersionCompareResult.swift

@@ -0,0 +1,26 @@
+//
+//  VersionValidationError.swift
+//  SwiftVersionCompare
+//
+//  Created by Marius Felkner on 29.12.20.
+//
+
+import Foundation
+
+enum VersionValidationError: Swift.Error {
+    case invalidVersionIdentifier(identifier: String)
+}
+
+extension VersionValidationError: LocalizedError {
+    var errorDescription: String? {
+        switch self {
+        case .invalidVersionIdentifier(let identifier):
+            let format = NSLocalizedString(
+                "The parsed string contained an invalid SemVer version identifier: '%@'.",
+                comment: ""
+            )
+
+            return String(format: format, identifier)
+        }
+    }
+}

Sources/SwiftVersionCompare/Helper/VersionValidationError.swift

@@ -2,7 +2,7 @@
 //  BuildMetaData+ExpressibleByLiteral.swift
 //  SwiftVersionCompare
 //
-//  Created by Marius Hötten-Löns on 12.03.21.
+//  Created by Marius Felkner on 12.03.21.
 //
 
 extension BuildMetaData: LosslessStringConvertible {

Sources/SwiftVersionCompare/SemanticVersionComparable/BuildMetaData/BuildMetaData+ExpressibleByLiteral.swift

@@ -2,10 +2,10 @@
 //  BuildMetaData.swift
 //  SwiftVersionCompare
 //
-//  Created by Marius Hötten-Löns on 12.03.21.
+//  Created by Marius Felkner on 12.03.21.
 //
 
-/// Typed build-meta-data.
+/// Enumerated build-meta-data for simple and `SemVer` conform access.
 ///
 /// - Note: Identifier can be described using alphanumeric letters or digits.
 ///