Merge pull request #24 from LIM-AeroCloud/rel/0.2.1

Rel/0.2.1

Author: pb866

CHANGELOG.md

@@ -3,6 +3,13 @@
 This project uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 The format of the release notes follows [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
+## [v0.2.1] - 2025-08-23
+
+## Changed
+
+- Documentation updates and fixes (improved installation instructions, removed all references to
+  URI type piracy; [#24])
+
 ## [v0.2.0] - 2025-08-22
 
 ### Changed
@@ -130,6 +137,7 @@ All changes for this released are documented in respect to this version.
 [v0.1.1]: https://github.com/LIM-AeroCloud/SFTP.jl/releases/tag/v0.1.1
 [v0.1.2]: https://github.com/LIM-AeroCloud/SFTP.jl/releases/tag/v0.1.2
 [v0.2.0]: https://github.com/LIM-AeroCloud/SFTP.jl/releases/tag/v0.2.0
+[v0.2.1]: https://github.com/LIM-AeroCloud/SFTP.jl/releases/tag/v0.2.1
 [#8]: https://github.com/LIM-AeroCloud/SFTP.jl/issues/8
 [#9]: https://github.com/LIM-AeroCloud/SFTP.jl/issues/9
 [#10]: https://github.com/LIM-AeroCloud/SFTP.jl/issues/10
@@ -138,3 +146,4 @@ All changes for this released are documented in respect to this version.
 [#18]: https://github.com/LIM-AeroCloud/SFTP.jl/issues/18
 [#21]: https://github.com/LIM-AeroCloud/SFTP.jl/issues/21
 [#22]: https://github.com/LIM-AeroCloud/SFTP.jl/issues/22
+[#24]: https://github.com/LIM-AeroCloud/SFTP.jl/issues/24

Project.toml

@@ -1,7 +1,7 @@
 name = "SFTP"
 uuid = "f44f501d-421f-4286-bfa3-132bd4e9b35e"
 authors = ["Peter Bräuer <pb866.git@gmail.com>"]
-version = "0.2.0"
+version = "0.2.1"
 
 [deps]
 Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"

docs/make.jl

@@ -15,6 +15,7 @@ makedocs(
     sitename="SFTP.jl Documentation",
     checkdocs=:public,
     format=Documenter.HTML(;
+        prettyurls=false,
         canonical="https://LIM-AeroCloud.github.io/SFTP.jl",
         edit_link="dev",
         assets=String[],

docs/src/filesystem.md

@@ -9,8 +9,7 @@ functions, respectively, however, _SFTP.jl_'s functionality might be reduced.
 
 Several of the Filesystem functions return a `URI` struct from the
 [URIs package](https://github.com/JuliaWeb/URIs.jl.git) to represent the complete
-server address including the path on the server. `URI` structs are also accepted as
-input argument by serveral of _SFTP.jl_'s Filesystem functions.
+server address including the path on the server.
 For easier handling, the `URI` struct is exported by _SFTP.jl_ as well. See
 [URIs' documentation](https://docs.juliahub.com/URIs/eec2u/1.5.1/#URIs.URI)
 for more details on the `URI` struct.

docs/src/index.md

@@ -22,12 +22,27 @@ to the typical Linux functionality exist to explore the SFTP server.
 
 ## SFTP Installation
 
-Install using the package manager:
+_SFTP.jl_ is an unregistered Julia package, but can be installed with the package manager:
 
-```julia
+```console
 julia> ]
 
-pkg> add SFTP
+pkg> add https://github.com/LIM-AeroCloud/SFTP.jl.git
+```
+
+By default, the development version will be install. To use released stable version switch to
+the `main` channel by installing _SFTP.jl_ with:
+
+```console
+pkg> add https://github.com/LIM-AeroCloud/SFTP.jl.git#main
+```
+
+The package is developed for MacOS and Linux, but can be used under Windows as well.
+It is tested against the long-term support version (LTS) of Julia, the latest stable version,
+and the nightly version. To run test on your system open the package manager and type `test`:
+
+```console
+pkg> test
 ```
 
 ## Contents

docs/src/release-notes.md

@@ -7,6 +7,13 @@ EditURL = "https://github.com/LIM-AeroCloud/SFTP.jl/blob/master/CHANGELOG.md"
 This project uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 The format of the release notes follows [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
+## [v0.2.1](https://github.com/LIM-AeroCloud/SFTP.jl/releases/tag/v0.2.1) - 2025-08-23
+
+## Changed
+
+- Documentation updates and fixes (improved installation instructions, removed all references to
+  URI type piracy; [#24](https://github.com/LIM-AeroCloud/SFTP.jl/issues/24))
+
 ## [v0.2.0](https://github.com/LIM-AeroCloud/SFTP.jl/releases/tag/v0.2.0) - 2025-08-22
 
 ### Changed

src/filesystem.jl

@@ -391,7 +391,9 @@ updated path. Any `path` components prior to an absolute `path` are dropped.
 
 !!! note
     The `uri` field of the `sftp` client remains unaffected by joinpath.
-    Use `sftp.uri = joinpath(sftp, "new/path")` to update the URI on the `sftp` server.
+    Use `sftp.uri = joinpath(sftp, "new/path", "parts")` or
+    `cd(sftp, joinpath(sftp, joinpath("new/path", "parts")))` to update
+    the URI on the `sftp` server.
 """
 Base.joinpath(sftp::Client, path::AbstractString...)::URI = joinpath(sftp, string.(path...))
 Base.joinpath(sftp::Client, path::String...)::URI = joinpath(sftp.uri, path...)