docs(readme): adding Readme file

README.md

@@ -1,2 +1,102 @@
-# streamely-native-app
- Stream your favorite movies and TV shows for free, without ads. Enjoy a quick and hassle-free entertainment experience.
+# Streamely 
+
+[![Made With Javascript][made-with-javascript]][forthebadge-url]
+[![Built With Love][built-with-love]][forthebadge-url]
+
+[![MIT License][license-shield]][license-url]
+[![Contributors][contributors-shield]][contributors-url]
+[![Forks][forks-shield]][forks-url]
+[![Stargazers][stars-shield]][stars-url]
+[![Issues][issues-shield]][issues-url]
+
+
+<h4 align="left"> Streamely is streaming app built on top of <a href="https://cordova.apache.org/" target="_blank">Cordova</a>.</h4>
+
+## Key Features
+
+* Ad-free streaming experience 
+* Support for subtitles 
+* Simple and intuitive interface 
+* Easy search functionality for movies and TV shows
+
+## Disclaimer
+
+> **Important:** I am not in support of any form of piracy. I just like coding and having many users and all that. This app is meant to serve the purpose of education and showcasing the technical abilities that are involved in Cordova as well as Android development. 
+
+## Demo
+
+<img src="https://github.com/elyeandre/streamely-native-app/blob/081dd521a06f71955309feec8a0f731b413468a8/demo.gif" alt="Demo of Streamely App" width="200">
+
+> **Note:** To use this app, you'll need the MPV player. You can download the modified version of MPV for Android that supports passing headers via intent from [this link](https://r2-api.mayor.workers.dev/mpv.apk). If the downloaded file has a `.zip` extension, rename the file extension to `.apk` before installing.
+## Getting Started
+
+These instructions will give you a copy of the project up and running on your local machine for development and testing purposes.
+
+### Prerequisites
+
+To set up your development environment, you'll need certain tools and versions. Because JDK and Gradle versions can depend on the specific version of Cordova you're using, we recommend referring to the official [Cordova Android Platform Guide](https://cordova.apache.org/docs/en/12.x/guide/platforms/android/index.html) for detailed setup instructions.
+
+Here are the general prerequisites:
+
+* Java Development Kit (JDK)  
+* Gradle  
+* Android SDK 
+
+### Installation
+
+To clone and run this application, you'll need [Git](https://git-scm.com) and [Node.js](https://nodejs.org/en/download/) (which comes with [npm](http://npmjs.com)) installed on your computer. From your command line:
+
+
+```
+# Clone this repository
+$ git clone https://github.com/elyeandre/streamely-native-app 
+
+# Go into the repository
+$ cd streamely-native-app 
+
+# Install cordova
+$ npm install -g cordova
+
+# Install dependencies
+$ npm install
+
+# Add a platform
+$ cordova platform add android 
+
+# Build  
+$ npm run build
+```
+
+
+
+## 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 (`git checkout -b feature/AmazingFeature`)
+3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the Branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
+
+## License
+
+<!-- MARKDOWN LINK & IMAGES -->
+This software is licensed under the [MIT](https://github.com/elyeandre/streamely-native-app/blob/main/LICENSE) © [elyeandre](https://github.com/elyeandre).
+
+[license-shield]: https://img.shields.io/github/license/othneildrew/Best-README-Template.svg?style=for-the-badge
+[license-url]: https://github.com/othneildrew/Best-README-Template/blob/master/LICENSE.txt
+[made-with-javascript]: http://forthebadge.com/images/badges/made-with-javascript.svg
+[built-with-love]: https://forthebadge.com/images/badges/built-with-love.svg
+[forthebadge-url]: http://forthebadge.com
+[contributors-shield]: https://img.shields.io/github/contributors/elyeandre/streamely-native-app.svg?style=for-the-badge
+[contributors-url]: https://github.com/elyeandre/streamely-native-app/graphs/contributors
+[forks-shield]: https://img.shields.io/github/forks/elyeandre/streamely-native-app.svg?style=for-the-badge
+[forks-url]: https://github.com/elyeandre/streamely-native-app/network/members
+[stars-shield]: https://img.shields.io/github/stars/elyeandre/streamely-native-app.svg?style=for-the-badge
+[stars-url]: https://github.com/elyeandre/streamely-native-app/stargazers
+[issues-shield]: https://img.shields.io/github/issues/elyeandre/streamely-native-app.svg?style=for-the-badge
+[issues-url]: https://github.com/elyeandre/streamely-native-app/issues