diff --git a/.cspell/words.txt b/.cspell/words.txt index 5bd28a53..fefbc103 100644 --- a/.cspell/words.txt +++ b/.cspell/words.txt @@ -128,6 +128,7 @@ libcurl libdsm libevent libexample +libexpat libfuse3 libgmock libgtest diff --git a/README.md b/README.md index 32976dd6..568a97c1 100644 --- a/README.md +++ b/README.md @@ -30,35 +30,6 @@ on Windows. ## Usage -### Notable Options - -* `-dc` - * Display mount configuration. - * For Sia, `--name` is optional - * For S3, the `-s3` option is required along with `--name` -* `--help` - * Display all mount utility options. -* `--name, -na [name]` - * The `--name` option can be set to any valid value allowed as a file name for your filesystem. - * For Sia, the bucket name will be set to the same value if it is empty in the configuration file. - * If the `--name` option is not specified, `default` will be used. - * For S3, the `--name` option is required and does not affect the bucket name. -* `-set SiaConfig.Bucket` - * Sets the Sia bucket name to mount. - * Can be used in combination with `--name` to target a unique configuration. -* `-set S3Config.Bucket` - * Sets the S3 bucket name to mount. - * Must be used in combination with `--name` to target a unique configuration. - * Must be used in combination with `-s3`. - -### Data Directories - -* Linux - * `~/.local/repertory2` -* Windows - * `%LOCALAPPDATA%\repertory2` - * i.e. `C:\\Users\\Tom\\AppData\\Local\\repertory2` - ### Sia * Initial Configuration @@ -72,7 +43,7 @@ on Windows. * For all other configurations: * `repertory --name '' -set HostConfig.ApiPassword ''` * `repertory --name '' -set SiaConfig.Bucket ''` - * To verify all configuration options: + * To verify/view all configuration options: * `repertory -dc` or `repertory --name '' -dc` * Mounting on Linux: * `repertory /mnt/location` @@ -100,13 +71,39 @@ on Windows. * `repertory --name '' -set S3Config.Region ''` * Optionally, to enable encrypted file names and file data, set a strong, random encryption token: * `repertory --name '' -set S3Config.EncryptionToken ''` - * To verify all configuration options: + * To verify/view all configuration options: * `repertory -dc` or `repertory --name '' -dc` * Mounting on Linux: * `repertory -s3 --name '' /mnt/location` * Mounting on Windows: * `repertory -s3 --name '' t:` +### Notable Options + +* `--help` + * Display all mount utility options. +* `-dc` + * Display mount configuration. + * For Sia, `--name` is optional + * For S3, the `-s3` option is required along with `--name` +* `--name, -na [name]` + * The `--name` option can be set to any valid value allowed as a file name for your filesystem. + * For Sia, the bucket name will be set to the same value if it is empty in the configuration file. + * If the `--name` option is not specified, `default` will be used. + * For S3, the `--name` option is required and does not affect the bucket name. + +### Data Directories + +* Linux + * `~/.local/repertory2` +* Windows + * `%LOCALAPPDATA%\repertory2` + * Example: + * `C:\Users\Tom\AppData\Local\repertory2` + * IMPORTANT: + * It is recommended to exclude this folder from any anti-virus/anti-malware applications as severe performance issues may arrise. + * Excluding the mounted drive letter is also highly recommended. + ## Remote Mounting `Repertory` allows local mounts to be shared with other computers on your network. This option is referred to as remote mounting. @@ -139,17 +136,27 @@ Instructions TBD. ## Credits +* [binutils](https://www.gnu.org/software/binutils/) * [boost c++ libraries](https://www.boost.org/) * [cpp-httplib](https://github.com/yhirose/cpp-httplib) * [curl](https://curl.haxx.se/) +* [docker](https://www.docker.com/) * ~~[FUSE for macOS](https://osxfuse.github.io/)~~ * [Google Test](https://github.com/google/googletest) +* [ICU](https://icu.unicode.org/) * [JSON for Modern C++](https://github.com/nlohmann/json) +* [libexpat](https://github.com/libexpat/libexpat) * [libfuse](https://github.com/libfuse/libfuse) * [libsodium](https://doc.libsodium.org/) +* [mingw-w64](https://www.mingw-w64.org/) +* [MSYS2](https://www.msys2.org) * [OpenSSL](https://www.openssl.org/) +* [pkg-config](https://www.freedesktop.org/wiki/Software/pkg-config/) +* [pugixml](https://pugixml.org/) +* [RocksDB](https://rocksdb.org) * [ScPrime](https://scpri.me/) * [Sia Decentralized Cloud Storage](https://sia.tech/) +* [spdlog](https://github.com/gabime/spdlog) * [SQLite](https://www.sqlite.org) * [stduuid](https://github.com/mariusbancila/stduuid) * [Storj](https://storj.io/)