update: Readme.md

README.md

@@ -2,15 +2,15 @@
 
 Effortlessly manage your database backups at one go. This easy-to-use tool supports MySQL & PostgreSQL allowing you to back up multiple databases at once.
 
-#### Key features include:
+#### Key features include: 🚀
 
-- Multiple Database Support: Seamlessly back up MySQL & PostgreSQL in one go. Note: For now we support MySQL and PostgreSQl.
-- Automated Backups: Schedule and automate backups to ensure your data is always protected without manual intervention.
-- Compression: Compress backups into zip files to save storage space and optimize transfer times.
-- Email Integration: Instantly send backup files directly to your inbox or designated recipients for easy access and archiving.
-- Get Notified: Receive notifications for successful and failed backups to stay informed and take action as needed. (on Discord or Slack). _Supports only one Notifier for all backups_
+- Multiple Database Support: Seamlessly back up MySQL & PostgreSQL in one go. (Note: For now we support MySQL and PostgreSQl.)
+- Support for GMAIL,S3 BUCKET for storing the backup. (Backups are transfered in zip format, reducing backup size.)
+- Multiple Email Recipients: Send backups to multiple email recipients. (if `BACKUP_DEST` is set to `GMAIL`)
+- Notify on Discord or Slack for successful and failed backups.
+- Automated Backups: Schedule and automate backups (using crons or pm2) to ensure your data is always protected without manual intervention.
 
-## Clone the project :
+## Clone the project 📦
 
 ```
 git clone https://github.com/28softwares/autobackup-db-and-email.git
@@ -22,50 +22,12 @@ cd autobackup-db-and-email
 Make sure to install nodejs and zip in the linux server.
 
 ```bash
-    sudo apt-get install zip && npm i
-    # make it executable
-    chmod +x index.sh
-    #To test the file Run the following command.
-    ./index.sh
+node index.mjs install #this creates .env file
 ```
 
-### Configurations
+### Configurations ⚒️
 
-Add your database configuration in '.env' as
-
-```env
-
-
-# use for postgres.
-POSTGRES_DB_HOST='localhost'
-POSTGRES_DB_USER='postgres'
-POSTGRES_DB_PASSWORD='password'
-POSTGRES_DB_NAME='database_name' #also set multiple database names separated by comma.i.e. 'database_name,database_name2,database_name3'
-
-POSTGRES_DB_PORT=5432
-#ignore postgres config in env if not used.
-
-
-# use for mysql.
-MYSQL_DB_HOST='localhost'
-MYSQL_DB_USER='root'
-MYSQL_DB_PASSWORD='password'
-MYSQL_DB_NAME='database_name' #multiple db names as like above.
-MYSQL_DB_PORT=3306
-#ignore mysql config in env if not used.
-
-
-```
-
-To send backup through mail you need to add mail credentials to .env.
-Note: You cannot pass your regular password if 2FA is enabled on your mail account. For this, You can create an app specific password from here [Google App Password]: https://myaccount.google.com/apppasswords.
-
-```bash
-  MAIL_USER='[email protected]'
-  MAIL_PASSWORD='example password'
-```
-
-Set the cronjob.
+For GMAIL, you need to enable less secure apps in your gmail account. [Click here to enable less secure apps](https://myaccount.google.com/lesssecureapps)
 
 ```bash
 crontab -e
@@ -81,13 +43,12 @@ _OR, you can use process managers as_
 pm2 start src/index.js --name dbbackup --cron "* * * * *"
 ```
 
-## Feel Free To Contribute
+## Feel Free To Contribute 👌
 
 Customize it further based on your tool’s specific features and benefits! PR are welcome.
 
 ---
 
-## Todos
+## Todos ✅
 
-- [ ] Multiple Email Support (Currently, only one email can be sent. We can add multiple emails to send the backup to multiple people)
-- [ ] To make project CLI Based (Since we have `scripts/dump_data_for_test.sh` which we have to do manually, but if we can make cli based from `index.sh` then it will be more user friendly; by providing flags)
+- [ ] (Under progress) To make project CLI Based (Since we have `scripts/dump_data_for_test.sh` which we have to do manually, but if we can make cli based from `index.sh` then it will be more user friendly; by providing flags)