diff --git a/radicle-surf/CHANGELOG.md b/radicle-surf/CHANGELOG.md new file mode 100644 index 0000000..aa25894 --- /dev/null +++ b/radicle-surf/CHANGELOG.md @@ -0,0 +1,17 @@ +## Version 0.9.0 + +This release consists of a major rewrite of this crate. Its API is overall +simplified and is not compatible with the previous version (v0.8.0). The main +changes include: + +- `Browser` is removed. Its methods are implemented directly with `Repository`. +- Git will be the only supported VCS. Any extension points for other VCSes were +removed. +- `Ref` and `RefScope` are removed. Re-use the `git-ref-format` crate and a new +`Glob` type for the refspec patterns. +- Added support of `Tree` and `Blob` that correspond to their definitions in +Git. +- Added two new traits `Revision` and `ToCommit` that make methods flexible and +still simple to use. + +For more details, please check out the crate's documentation. diff --git a/radicle-surf/Cargo.toml b/radicle-surf/Cargo.toml index 6c7048e..389420e 100644 --- a/radicle-surf/Cargo.toml +++ b/radicle-surf/Cargo.toml @@ -1,8 +1,8 @@ [package] name = "radicle-surf" -description = "A code surfing library for VCS file systems" +description = "A code surfing library for Git repositories" readme = "README.md" -version = "0.8.0" +version = "0.9.0" authors = ["The Radicle Team "] edition = "2021" homepage = "https://github.com/radicle-dev/radicle-surf"