diff --git a/README.md b/README.md new file mode 100644 index 0000000..5b67c4f --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +# JetSleepSounds - Work in Progress + +JetSleepSounds is a TV-first design, leveraging Jetpack Compose for TV to create a unique audio experience with a focus on simplicity and functionality. The application is currently in active development, with various features and improvements planned. + +## Key Features +- **Audio Playback**: Utilizing ExoPlayer for seamless audio playback. +- **Background Image Player**: Enjoy a visually appealing experience with background images corresponding to the audio. +- **Audio Mixer (Work in Progress)**: Customize your experience with volume settings and more. + +## Key Components +- **TVLazyHorizontalGrid**: Responsive grid layout for an optimized TV viewing experience. +- **Crossfade**: Smooth transitions between different states and screens. +- **Buttons, Dialogs, Images, Texts, Rows, etc.**: Essential UI components for a rich and intuitive user interface. + +## Key Libraries +- **ExoPlayer**: Powerful and customizable media player for audio playback. +- **Coil**: Image loading library for efficient image handling. +- **Cloudy**: *Need information about Cloudy library*. +- **Lottie**: Seamless integration of Lottie animations for an engaging user experience. + +## Screenshots + +### Home Screen +![Home Screen](https://github.com/UmairKhalid786/JetSleepSounds/assets/21205138/e94a96fe-645e-49e0-95b8-3f716f634944) + +### Mixer +![Mixer](https://github.com/UmairKhalid786/JetSleepSounds/assets/21205138/bf0e753e-0c61-43b2-8a39-74f2621f304c) + +### Player Preferences - More to be added +![Detailed Preferences](https://github.com/UmairKhalid786/JetSleepSounds/assets/21205138/5f07cf18-a67b-4e18-aeab-ba88e9216841) + +## Important Notes +- This project is an ongoing ideation, and work is still in progress. Some Compose guidelines have been temporarily ignored for rapid development. +- There is a considerable amount of hardcoded data (images, songs, Lottie animations) that will be refactored in future updates. +- Memory management is currently unstable, and optimizations are planned in upcoming releases. + +Feel free to contribute, report issues, or provide suggestions as we work towards creating a polished and user-friendly audio experience for TV users. +