From 096c3c8256dd272ea141952f93bd741e7f3e1e50 Mon Sep 17 00:00:00 2001 From: Marcel Schramm Date: Thu, 23 Nov 2023 15:16:08 +0100 Subject: [PATCH] Update readme --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 0f0a7d4..fa62911 100644 --- a/README.md +++ b/README.md @@ -84,6 +84,8 @@ func main() { ## CLI usage +**UNSTABLE, USE AT YOUR OWN RISK** + Wastebasket can also be used as a commandline interface. You can build executables for each subcommand (such as `empty`) separately, or build `wastebasket` as a whole. @@ -109,6 +111,20 @@ source <(wastebasket completion bash) Additionally, completion is supported for zsh, powershell and fish. For information, see [Cobra shell completions](https://github.com/spf13/cobra/blob/main/shell_completions.md) +## Tests + +For windows, there is a utility that allows you to run linux or windows tests +using containers. This prevents the utilitiy from accidentally deleting files or +emptying your trashbin. + +Simply execute: + +```powershell +test +``` + +Note that this doesn't work when you are on linux. + ## Benchmarks Run benchmarks using: