Create README structure

README.md

@@ -1,5 +1,285 @@
-# Media Sorter
+<!-- PROJECT SHIELDS -->
+<!--
+*** I'm using markdown "reference style" links for readability.
+*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
+*** See the bottom of this document for the declaration of the reference variables
+*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
+*** https://www.markdownguide.org/basic-syntax/#reference-style-links
+-->
+[![Contributors][contributors-shield]][contributors-url]
+[![Forks][forks-shield]][forks-url]
+[![Stargazers][stars-shield]][stars-url]
+[![Issues][issues-shield]][issues-url]
+[![MIT License][license-shield]][license-url]
+[![LinkedIn][linkedin-shield]][linkedin-url]
 
-A python app to sort and manage media by date, camera type, etc ... using metadata.
 
-[//]: # (Todo: Create the Readme)
+
+<!-- PROJECT LOGO -->
+<br />
+<div align="center">
+  <a href="https://github.com/obeidahmad/family-media-sorter">
+    <img src="images/logo.svg" alt="Logo" width="80" height="80">
+  </a>
+
+  <h3 align="center">Media Sorter</h3>
+
+  <p align="center">
+    A simple script to sort your media!
+    <br />
+    <a href="https://github.com/obeidahmad/family-media-sorter"><strong>Explore the docs »</strong></a>
+    <br />
+    <br />
+    <a href="https://github.com/obeidahmad/family-media-sorter">View Demo</a>
+
+[//]: # (    ·)
+
+[//]: # (    <a href="https://github.com/othneildrew/Best-README-Template/issues/new?labels=bug&template=bug-report---.md">Report Bug</a>)
+
+[//]: # (    ·)
+
+[//]: # (    <a href="https://github.com/othneildrew/Best-README-Template/issues/new?labels=enhancement&template=feature-request---.md">Request Feature</a>)
+  </p>
+</div>
+
+
+
+<!-- TABLE OF CONTENTS -->
+<details>
+  <summary>Table of Contents</summary>
+  <ol>
+    <li>
+      <a href="#about-the-project">About The Project</a>
+      <ul>
+        <li><a href="#built-with">Built With</a></li>
+      </ul>
+    </li>
+    <li>
+      <a href="#getting-started">Getting Started</a>
+      <ul>
+        <li><a href="#prerequisites">Prerequisites</a></li>
+        <li><a href="#installation">Installation</a></li>
+      </ul>
+    </li>
+    <li><a href="#usage">Usage</a></li>
+    <li><a href="#roadmap">Roadmap</a></li>
+    <li><a href="#contributing">Contributing</a></li>
+    <li><a href="#license">License</a></li>
+    <li><a href="#contact">Contact</a></li>
+    <li><a href="#acknowledgments">Acknowledgments</a></li>
+  </ol>
+</details>
+
+
+
+<!-- ABOUT THE PROJECT -->
+## About The Project
+
+There are many great media sorters out there, but none really suited me. So I created my own. The main idea here is simplicity, and the ability to sort even media who has missing or unusual tags.
+This app is built with [![Python][Python]][Python] and leverages  [![ExifTool][ExifTool]][ExifTool-url]
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+[//]: # (<!-- GETTING STARTED -->)
+
+[//]: # (## Getting Started)
+
+[//]: # ()
+[//]: # (This is an example of how you may give instructions on setting up your project locally.)
+
+[//]: # (To get a local copy up and running follow these simple example steps.)
+
+[//]: # ()
+[//]: # (### Prerequisites)
+
+[//]: # ()
+[//]: # (This is an example of how to list things you need to use the software and how to install them.)
+
+[//]: # (* npm)
+
+[//]: # (  ```sh)
+
+[//]: # (  npm install npm@latest -g)
+
+[//]: # (  ```)
+
+[//]: # ()
+[//]: # (### Installation)
+
+[//]: # ()
+[//]: # (_Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services._)
+
+[//]: # ()
+[//]: # (1. Get a free API Key at [https://example.com]&#40;https://example.com&#41;)
+
+[//]: # (2. Clone the repo)
+
+[//]: # (   ```sh)
+
+[//]: # (   git clone https://github.com/your_username_/Project-Name.git)
+
+[//]: # (   ```)
+
+[//]: # (3. Install NPM packages)
+
+[//]: # (   ```sh)
+
+[//]: # (   npm install)
+
+[//]: # (   ```)
+
+[//]: # (4. Enter your API in `config.js`)
+
+[//]: # (   ```js)
+
+[//]: # (   const API_KEY = 'ENTER YOUR API';)
+
+[//]: # (   ```)
+
+[//]: # ()
+[//]: # (<p align="right">&#40;<a href="#readme-top">back to top</a>&#41;</p>)
+
+[//]: # ()
+[//]: # ()
+[//]: # ()
+[//]: # (<!-- USAGE EXAMPLES -->)
+
+[//]: # (## Usage)
+
+[//]: # ()
+[//]: # (Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.)
+
+[//]: # ()
+[//]: # (_For more examples, please refer to the [Documentation]&#40;https://example.com&#41;_)
+
+[//]: # ()
+[//]: # (<p align="right">&#40;<a href="#readme-top">back to top</a>&#41;</p>)
+
+[//]: # ()
+[//]: # ()
+[//]: # ()
+[//]: # (<!-- ROADMAP -->)
+
+[//]: # (## Roadmap)
+
+[//]: # ()
+[//]: # (- [x] Add Changelog)
+
+[//]: # (- [x] Add back to top links)
+
+[//]: # (- [ ] Add Additional Templates w/ Examples)
+
+[//]: # (- [ ] Add "components" document to easily copy & paste sections of the readme)
+
+[//]: # (- [ ] Multi-language Support)
+
+[//]: # (    - [ ] Chinese)
+
+[//]: # (    - [ ] Spanish)
+
+[//]: # ()
+[//]: # (See the [open issues]&#40;https://github.com/othneildrew/Best-README-Template/issues&#41; for a full list of proposed features &#40;and known issues&#41;.)
+
+[//]: # ()
+[//]: # (<p align="right">&#40;<a href="#readme-top">back to top</a>&#41;</p>)
+
+[//]: # ()
+[//]: # ()
+[//]: # ()
+[//]: # (<!-- CONTRIBUTING -->)
+
+[//]: # (## Contributing)
+
+[//]: # ()
+[//]: # (Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.)
+
+[//]: # ()
+[//]: # (If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".)
+
+[//]: # (Don't forget to give the project a star! Thanks again!)
+
+[//]: # ()
+[//]: # (1. Fork the Project)
+
+[//]: # (2. Create your Feature Branch &#40;`git checkout -b feature/AmazingFeature`&#41;)
+
+[//]: # (3. Commit your Changes &#40;`git commit -m 'Add some AmazingFeature'`&#41;)
+
+[//]: # (4. Push to the Branch &#40;`git push origin feature/AmazingFeature`&#41;)
+
+[//]: # (5. Open a Pull Request)
+
+[//]: # ()
+[//]: # (<p align="right">&#40;<a href="#readme-top">back to top</a>&#41;</p>)
+
+
+
+<!-- LICENSE -->
+## License
+
+Distributed under the Apache-2.0 License. See `LICENSE.txt` for more information.
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+<!-- CONTACT -->
+## Contact
+
+Ahmad Obeid - obeid.ahmad2001@outlook.com
+
+Project Link: [https://github.com/obeidahmad/family-media-sorter](https://github.com/obeidahmad/family-media-sorter)
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+[//]: # (<!-- ACKNOWLEDGMENTS -->)
+
+[//]: # (## Acknowledgments)
+
+[//]: # ()
+[//]: # (Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!)
+
+[//]: # ()
+[//]: # (* [Choose an Open Source License]&#40;https://choosealicense.com&#41;)
+
+[//]: # (* [GitHub Emoji Cheat Sheet]&#40;https://www.webpagefx.com/tools/emoji-cheat-sheet&#41;)
+
+[//]: # (* [Malven's Flexbox Cheatsheet]&#40;https://flexbox.malven.co/&#41;)
+
+[//]: # (* [Malven's Grid Cheatsheet]&#40;https://grid.malven.co/&#41;)
+
+[//]: # (* [Img Shields]&#40;https://shields.io&#41;)
+
+[//]: # (* [GitHub Pages]&#40;https://pages.github.com&#41;)
+
+[//]: # (* [Font Awesome]&#40;https://fontawesome.com&#41;)
+
+[//]: # (* [React Icons]&#40;https://react-icons.github.io/react-icons/search&#41;)
+
+[//]: # ()
+[//]: # (<p align="right">&#40;<a href="#readme-top">back to top</a>&#41;</p>)
+
+
+
+<!-- MARKDOWN LINKS & IMAGES -->
+<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
+[contributors-shield]: https://img.shields.io/github/contributors/obeidahmad/family-media-sorter.svg?style=for-the-badge
+[contributors-url]: https://github.com/obeidahmad/family-media-sorter/graphs/contributors
+[forks-shield]: https://img.shields.io/github/forks/obeidahmad/family-media-sorter.svg?style=for-the-badge
+[forks-url]: https://github.com/obeidahmad/family-media-sorter/network/members
+[stars-shield]: https://img.shields.io/github/stars/obeidahmad/family-media-sorter.svg?style=for-the-badge
+[stars-url]: https://github.com/obeidahmad/family-media-sorter/stargazers
+[issues-shield]: https://img.shields.io/github/issues/obeidahmad/family-media-sorter.svg?style=for-the-badge
+[issues-url]: https://github.com/obeidahmad/family-media-sorter/issues
+[license-shield]: https://img.shields.io/github/license/obeidahmad/family-media-sorter.svg?style=for-the-badge
+[license-url]: https://github.com/obeidahmad/family-media-sorter/blob/master/LICENSE.txt
+[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
+[linkedin-url]: https://linkedin.com/in/ahmad-obeid-487a8a204/
+[Python]: https://img.shields.io/badge/python-3776AB?style=for-the-badge&logo=python&logoColor=white
+[Python-url]: https://www.python.org/
+[ExifTool]: https://img.shields.io/badge/exiftool-red.svg?style=for-the-badge&logo=data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBzdGFuZGFsb25lPSJubyI/Pgo8c3ZnIHByZXNlcnZlQXNwZWN0UmF0aW89InhNaWRZTWlkIG1lZXQiIHZpZXdCb3g9IjM1LjE5OTk5OTk5OTk5OTk5NiAzMCAxMzUuMjAwMDAwMDAwMDAwMDIgMTQwLjc5OTk5OTk5OTk5OTk4IiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMCIgc3R5bGU9Im1heC1oZWlnaHQ6IDUwMHB4IiB3aWR0aD0iMTM1LjIwMDAwMDAwMDAwMDAyIiBoZWlnaHQ9IjE0MC43OTk5OTk5OTk5OTk5OCI+Cgo8ZyBzdHJva2U9Im5vbmUiIGZpbGw9IiMwMDAwMDAiIHRyYW5zZm9ybT0idHJhbnNsYXRlKDAuMDAwMDAwLDIwMC4wMDAwMDApIHNjYWxlKDAuMTAwMDAwLC0wLjEwMDAwMCkiPgo8cGF0aCBkPSJNMzcwIDExMDUgbDAgLTU2NSAzMzAgMCAzMzAgMCAwIDcwIDAgNzAgLTI1NSAwIC0yNTUgMCAwIDE5MCAwIDE5MCYjMTA7MjU1IDAgMjU1IDAgMCA2NSAwIDY1IC0yNTUgMCAtMjU1IDAgMCAxNzUgMCAxNzUgMjU1IDAgMjU1IDAgMCA2NSAwIDY1IC0zMzAmIzEwOzAgLTMzMCAwIDAgLTU2NXoiLz4KPHBhdGggZD0iTTc2MCAxMzcwIGwwIC03MCAxOTAgMCAxOTAgMCAwIC00OTUgMCAtNDk1IDgwIDAgODAgMCAwIDQ5NSAwIDQ5NSYjMTA7MTkwIDAgMTkwIDAgMCA3MCAwIDcwIC00NjAgMCAtNDYwIDAgMCAtNzB6Ii8+CjwvZz4KPC9zdmc+Cg==
+[ExifTool-url]: https://www.exiftool.org/

src/main.py

@@ -50,4 +50,4 @@ def main():
 
 
 if __name__ == "__main__":
-    main()
+    main()