From dbd6aeaa3d34829228b844ac92b814a4526dbc4f Mon Sep 17 00:00:00 2001
From: Ramazan Sancar <ramazansancar4545@gmail.com>
Date: Mon, 27 May 2024 13:45:23 +0300
Subject: [PATCH] upd: Windows install command added. (#8)

* upd: Readme updated.

* upd: Readme updated.

* upd: .gitignore & build command updated.

* upd: Resolve conversations.

* upd: Resolve conversations.

* upd: Readme updated.
---
 .gitignore |  3 ++
 README.md  | 88 ++++++++++++++++++++++++++++++++++++++++++++++--------
 2 files changed, 78 insertions(+), 13 deletions(-)
 create mode 100644 .gitignore

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..2bade9c
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,3 @@
+# Build file for the wedl project
+*.exe
+wedl
diff --git a/README.md b/README.md
index 294a3f2..14843e7 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,9 @@
 # wedl
+
 [![Test latest release](https://github.com/gnojus/wedl/actions/workflows/test.yml/badge.svg)](https://github.com/gnojus/wedl/actions/workflows/test.yml)
 
-## Command line utility to download from wetransfer 
+## Command line utility to download from wetransfer
+
 Easily download from wetransfer.com in the command line.
 
 Uses unofficial wetransfer API used when downloading with a browser.
@@ -9,32 +11,92 @@ Uses unofficial wetransfer API used when downloading with a browser.
 Written in Go.
 
 ## Usage
-```
+
+```bash
 $ wedl --help
 Usage:
   wedl [options] <URL>
 
 Options:
-  -h --help              Show this screen.
-  -v --version           Print version and exit.
-  -o FILE --output=FILE  Output file. Use - for stdout.
-  -p PATH --path=PATH	 Downloaded files directory.
-  -s --silent            Silent. Do not output anything to stderr.
-  -f --force             Overwrite files if needed.
-  -i --info              Write download info to stdout and exit.
+  -h --help               Show this screen.
+  -v --version            Print version and exit.
+  -o FILE --output=FILE   Output file. Use - for stdout.
+  -p PATH --path=PATH     Downloaded files directory.
+  -s --silent             Silent. Do not output anything to stderr.
+  -f --force              Overwrite files if needed.
+  -i --info               Write download info to stdout and exit.
 ```
 
 ## Instaling
-Download binaries from [releases](https://github.com/gnojus/wedl/releases). 
+
+Download binaries from [releases](https://github.com/gnojus/wedl/releases).
 
 Or compile from source and install with the [Go toolchain](https://go.dev/dl/):
-```
+
+```bash
 go install github.com/gnojus/wedl@latest
 ```
 
-Or build from a writeable source tree:
-```
+### Linux and MacOS
+
+Or compile from source:
+
+```bash
 git clone https://github.com/gnojus/wedl.git
 cd wedl 
 go build
 ```
+
+### Windows
+
+Compile from source:
+
+```sh
+git clone https://github.com/gnojus/wedl.git
+cd wedl
+
+:: Build
+
+:: Build executable
+go build
+
+
+:: Or Build with -output flag
+go build -o wedl.exe wedl.go
+```
+
+## Run
+
+### Linux and MacOS
+
+```bash
+./wedl --help
+```
+
+### Windows
+
+Run the executable:
+
+```sh
+wedl.exe --help
+```
+
+### Usage examples
+
+```sh
+:: Help
+go run . --help
+
+:: Standart Download
+go run . https://go.wetransfer.com/responsibility
+
+:: Download to ./test/ directory
+go run . -p=test https://we.tl/responsibility
+
+:: Download to downloaded.zip
+go run . -o=downloaded.zip https://we.tl/responsibility
+
+:: Write download info to stdout
+go run . -i https://we.tl/responsibility
+
+```