From fa1ad33e7e6f2391e7a4b7781dc4f7203be0a057 Mon Sep 17 00:00:00 2001 From: amkhrjee Date: Sat, 31 Dec 2022 01:01:30 +0530 Subject: [PATCH] add: readme update --- readme.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/readme.md b/readme.md index 20c7f22..a52af4d 100644 --- a/readme.md +++ b/readme.md @@ -5,12 +5,14 @@

GitHub code size in bytes GitHub - twitter +

## What does `ocwd` do? `ocwd` is a command line utility that downloads resources from any [MIT OCW](https://ocw.mit.edu/) course to any storage path provided by you. The resources are available under the creative commons license and MIT reserves all rights to the content. This tool simply scrapes the OCW website for resources and offers a simple and easy way for downloading any course resource for offline use. ## Installation +> This script works best on Windows. + `ocwd` is a [PowerShell](https://learn.microsoft.com/en-us/powershell/) script, therefore, it works wherever PowerShell works. Read their [installation guide](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell?view=powershell-7.3) for more information on this. This tool works with PowerShell `v7.x.x`. That means, it is recommended to update your PS installation to the latest available version.