diff --git a/README.md b/README.md index 059cd72..936e08c 100644 --- a/README.md +++ b/README.md @@ -1 +1,22 @@ -# node-whatsapp-drive-extractor \ No newline at end of file +# node-whatsapp-drive-extractor + +[![MIT license](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/ShaunLWM/node-whatsapp-drive-extractor/blob/master/LICENSE) + +Download your synced WhatsApp medias from Google Drive backup + +## Requirement +- NodeJS v8 and above + +## Instructions +1. Clone the repository using "git clone xxx" or download [master zip](https://github.com/ShaunLWM/node-whatsapp-drive-extractor/archive/master.zip) +2. `yarn install` +3. Rename `config-sample.js` to `config.js` and fill in required details `gmail,passw & celnumbr`. +4. Run `npm start` or `node index.js`. + +## Todo +- commandline version +- able to list files without downloading +- prevent files download duplication + +## Troubleshooting +- If you are using 2FA on Google, you have to generate an [App Password](https://support.google.com/accounts/answer/185833?hl=en) \ No newline at end of file diff --git a/package.json b/package.json index 34af6dc..c024565 100644 --- a/package.json +++ b/package.json @@ -2,6 +2,12 @@ "name": "node-whatsapp-drive-extractor", "version": "0.0.1", "main": "index.js", + "scripts": { + "start": "node index.js" + }, + "engines": { + "node": ">=8.0.0" + }, "repository": "https://github.com/ShaunLWM/node-whatsapp-drive-extractor.git", "author": "ShaunLWM", "license": "MIT", @@ -12,4 +18,4 @@ "request": "^2.88.0", "rsa-pem-from-mod-exp": "^0.8.4" } -} +} \ No newline at end of file