add readme

Author: techboy-coder

README.md

@@ -1,3 +1,77 @@
-# mmdl
+![carbon](./carbon.svg)
+
+# mmdl - Mega Music Downloader
+
+![License](https://img.shields.io/pypi/l/mmdl?style=for-the-badge) ![PyPI](https://img.shields.io/pypi/v/mmdl?style=for-the-badge) ![Downloads](https://img.shields.io/pypi/dw/mmdl?style=for-the-badge)
+
+## What is mmdl ❓
+
+MMDL is a cli app which allows you to quickly and efficiently download one or multiple songs from YouTube.
+
+### Why
+
+- 🕖 Fast: Thanks to *async code* and *multithreading*.
+- ⚡ Simple: Type `mmdl go`  and get started with downloading songs.
+- ✨ Powerful
+  - Find songs based on songs query/title
+  - Skip already existing songs
+  - Add metadata such as artist name and artwork
+
+## Requirements 👇
+
+- Python 3
+- FFmpeg
+
+## Install ❤️
+
+```bash
+pip install mmdl
+```
+
+⚡**That’s it! **⚡
+
+## Usage 🔥
+
+### Go
+
+*Very quick and easy way of running the cli. Few questions will be asked via prompts. **This is the recommended way!***
+
+```shell
+mmdl go
+```
+
+### Download
+
+*Fast and traditional way of running the cli. Pass arguments and have your songs downloaded. Useful for automation scripts.*
+
+```shell
+mmdl download <method> #(add -h for more information)
+```
+
+#### Methods
+
+- File `mmdl download file <location>`: Get songs from file. Then download them.
+- List `mmdl download list "Term1" "Term2" ...` or `mmdl download list -a` for a prompt: Add multiple songs as cli arguments or enter them in a prompt.
+- YTMusic (beta) `mmdl download ytmusi` : Download multiple songs from *YouTube Music liked songs playlist* (via parsing HTML)
+- Single `mmdl download single song name`: Download a single song.
+
+## Support ⚡
+
+### Bugs 🐛
+
+Please [open a issue](https://github.com/techboy-coder/mmdl/issues/new) with some information to reproduce your problem.
+
+### Questions ❓
+
+Please [start/check a discussion](https://github.com/techboy-coder/mmdl/discussions/new). 
+
+## Contributing 🤜
+
+We welcome contributions very much. They are appreciated. 
+
+### Steps
+
+1. Check for bugs/issues you would like to solve.
+2. Fork the repo and make your changes.
+3. Send a pull request.
 
-Mmdl [Mega Music Downloader] - A tool to easily download music.

build/lib/mmdl/__init__.py

@@ -1,5 +1 @@
-#comment
-import os
-import sys
-sys.path.append(os.path.abspath(os.path.join(os.path.dirname("__file__"), '..')))
-from cli import runme
+from .mdl import *

build/lib/mmdl/cli.py

@@ -15,7 +15,7 @@
 from lxml.html import fromstring
 import click
 from mmdl import MusicDownloader
-from ask import asker
+from .ask import asker
 from rich.console import Console
 import questionary
 console = Console()
@@ -318,7 +318,7 @@ def single(song, verbose, debug):
 
 
 def runme():
-  main
+  main()
 if __name__ == '__main__':
   runme()
   # :/ 

build/lib/mmdl/mdl.py

@@ -27,10 +27,10 @@
 # pretty.install()
 from rich.progress import track
 
-from globals import console
+from .globals import console
 
-from utils import Utils
-from yt_utils import YtdlUtils
+from .utils import Utils
+from .yt_utils import YtdlUtils
 
 
 ##Dev Dep

build/lib/mmdl/yt_utils.py

@@ -1,5 +1,5 @@
 from __future__ import unicode_literals
-from utils import Utils
+from .utils import Utils
 import youtube_dl
 from youtubesearchpython.__future__ import VideosSearch
 from ytmusicapi import YTMusic
@@ -8,7 +8,7 @@
 import os
 import eyed3
 import urllib
-from globals import console
+from .globals import console
 
 
 class YtdlUtils():