add: install guide

ocwd.ps1

@@ -1,29 +1,15 @@
 
 <#PSScriptInfo
 
-.VERSION 1.0
+.VERSION 1.0.0
 
 .GUID a31639e2-a8ab-4a29-9fed-66d5b5f9e1e9
 
-.AUTHOR aniru
+.AUTHOR Aniruddha Mukherjee
 
 .COMPANYNAME
 
-.COPYRIGHT
-    Copyright (C) 2022  Aniruddha Mukherjee
-
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+.COPYRIGHT Aniruddha Mukherjee
 
 .TAGS
 

readme.md

@@ -1,2 +1,19 @@
-# The OCW Downloader
-This downloads OCW courses
+<p align="center">
+<!--<img src="scoop.png" alt="Long live Scoop!"/>-->
+    <h1 align="center">ocwd</h1>
+</p>
+<p align="center" >
+   <img alt="GitHub code size in bytes" src="https://img.shields.io/github/languages/code-size/amkhrjee/ocwd">
+    <img alt="GitHub" src="https://img.shields.io/github/license/amkhrjee/ocwd">
+</p>
+
+## 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 in the public domain 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
+`ocwd` is a [PowerShell](https://learn.microsoft.com/en-us/powershell/) script, therefore, it works wherever PowerShell works. Currently, PowerShell is available on both Windows and UNIX (that covers both Linux and MacOS) systems. Read their [installation guide](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell?view=powershell-7.3) for more information on this.
+
+`ocwd` is available via the PowerShellGallery:
+```ps1
+Install-Script -Name ocwd
+```
+