summaryrefslogtreecommitdiff
path: root/CHANGELOG.md
diff options
context:
space:
mode:
authorJustin Wernick <justin@worthe-it.co.za>2023-06-15 21:44:55 +0200
committerJustin Wernick <justin@worthe-it.co.za>2023-06-15 21:44:55 +0200
commitb8a4698831626b8f1d473c92d0a880062dedbe1d (patch)
treeaf75a765b8be73b45237bc08c89ec9c162521bf9 /CHANGELOG.md
parent5eac40377ab8526717c6e4564bc1ab3067db68d8 (diff)
Added a changelog for completed todo items
Diffstat (limited to 'CHANGELOG.md')
-rw-r--r--CHANGELOG.md44
1 files changed, 44 insertions, 0 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..cd6ea83
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,44 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+This changelog focusses on changes which affect production users of this
+library. It will not mention any changes to code structure, internal design
+details, documentation, or testing unless they have some affect on the public
+API.
+
+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]
+
+## [0.1.1] - 2023-05-10
+
+### Changed
+
+- Updated documentation for installing to reference the package on crates.io.
+
+## [0.1.0] - 2023-05-10
+
+### Added
+
+- Initial release with minimum viable functionality
+ - Interactive command prompt
+ - Non-interactive commands can be run with -c
+ - Exit command
+ - Help command
+ - Responds appropriately to unknown commands
+ - Shell command history (only within same session)
+ - git init works for
+ - private repos
+ - shared repos
+ - git fetch / clone from a server using shackle-shell
+ - git push to a server using shackle-shell
+ - Repos are restricted to only expected paths
+ - List all repos
+ - Set the repo description, both during init or as a separate command
+ - Set the main branch of a repo, both during init or as a separate command
+
+[unreleased]: https://codeberg.org/worthe-it/shackle-shell/compare/v0.1.1...HEAD
+[0.1.1]: https://codeberg.org/worthe-it/shackle-shell/releases/tag/v0.1.1
+[0.1.0]: https://codeberg.org/worthe-it/shackle-shell/releases/tag/v0.1.0