From 8d70b55c002037778d6335b3241b5e5f21c253b0 Mon Sep 17 00:00:00 2001
From: Rupam golui <142140947+Itz-Agasta@users.noreply.github.com>
Date: Sun, 9 Feb 2025 21:54:25 +0530
Subject: [PATCH] Updated the Readme.md
---
.gitignore | 1 +
License | 21 ++++
README.md | 250 +++++++++++++++++++++++++++++++++++------
src/img/ethos_logo.jpg | Bin 0 -> 148314 bytes
src/img/ethos_ui.jpg | Bin 0 -> 157827 bytes
5 files changed, 240 insertions(+), 32 deletions(-)
create mode 100644 License
create mode 100644 src/img/ethos_logo.jpg
create mode 100644 src/img/ethos_ui.jpg
diff --git a/.gitignore b/.gitignore
index bdd352b..b7655b2 100644
--- a/.gitignore
+++ b/.gitignore
@@ -74,6 +74,7 @@ docs/_build/
#extra
.cache
+private/
#shell-script
./run_ui.sh
\ No newline at end of file
diff --git a/License b/License
new file mode 100644
index 0000000..6ae4a90
--- /dev/null
+++ b/License
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2025] [Rupam Golui]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
index d7aa2fc..b8cc294 100644
--- a/README.md
+++ b/README.md
@@ -1,39 +1,112 @@
-# ethos
+**Ethos
**
-cli music player (Coming Soon)
+
+ 
+
-## Repository Structure
+
+
+[](https://www.python.org/downloads/)
+[](LICENSE)
+[](https://github.com/Itz-Agasta/ethos/pulls)
+[](https://codecov.io/gh/Itz-Agasta/ethos)
+[](https://pypi.org/project/ethos/)
+[](https://github.com/Itz-Agasta/ethos/issues)
+[](https://github.com/Itz-Agasta/ethos/stargazers)
+[](https://github.com/Itz-Agasta/ethos/commits/main)
+
+
+
+
+ A modern, resource-efficient CLI music player that seamlessly integrates local music libraries with online streaming services. Experience high-quality audio playback, Spotify playlist synchronization, and an intuitive terminal interface designed for both developers and music enthusiasts.
+
+
+ View Demo
+ ยท
+ Report Bug
+ ยท
+ Request Feature
+ ยท
+ Send a Pull Request
+
+
+
+## Table of Contents
+
+- [Table of Contents](#table-of-contents)
+- [Features](#features)
+- [Preview](#preview)
+- [Technologies Used](#technologies-used)
+- [Prerequisites](#prerequisites)
+- [Quick Start](#quick-start)
+- [Installation](#installation)
+ - [For Development:](#for-development)
+ - [For Distribution:](#for-distribution)
+- [Usage:](#usage)
+ - [Basic Commands](#basic-commands)
+ - [Queue Management](#queue-management)
+ - [Keyboard Shortcuts](#keyboard-shortcuts)
+ - [Basic Workflow](#basic-workflow)
+- [Troubleshooting](#troubleshooting)
+ - [Common Issues](#common-issues)
+- [Repository Structure](#repository-structure)
+- [Contributors](#contributors)
+- [License](#license)
+
+## Features
+
+๐ต **Universal Accessibility**
+
+- High-quality terminal music playback accessible to both developers and general users
+- Modern and feature-rich interface in your terminal
+- Support for multiple audio formats (MP3, FLAC, WAV, AAC)
+
+๐ป **Resource Efficient**
+
+- Lightweight application with minimal system resource consumption
+- Can be used in devices like Raspberry Pi
+- Optimized for lower-end devices without compromising functionality
+
+๐ **Unified Music Experience**
+
+- Seamlessly bridges local music libraries with online streaming services
+- All your music needs handled from a single terminal interface
+- Import and sync your Spotify playlists
+- Offline playback for downloaded tracks
+
+โก **Developer-Centric**
+
+- Terminal-native music solution that integrates with your development workflow
+- Enhances productivity by keeping you in your preferred environment
+
+## Preview
+
+
+ 
+
+
+## Technologies Used
+
+- **Backend:** yt-dlp, python-vlc, spotify API, spotipy
+- **Frontend:** Rich, Textual
+- **Language:** Python
+
+## Prerequisites
+
+Make sure you have the following installed:
+
+- Python 3.8 or later
+- pip (Python package installer)
+- VLC media player
+
+## Quick Start
```bash
-ethos/
-โโโ .editorconfig
-โโโ .gitignore
-โโโ .github/
-โ โโโ ISSUE_TEMPLATE/
-โ โโโ workflows/
-โโโ docker/
-โ โโโ dockerfile
-โ โโโ compose.yaml
-โ โโโ readme.md
-โโโ ethos/
-โ โโโ __init__.py
-โ โโโ main.py # entry point of the application.
-โ โโโ config.py # Manages configuration settings.
-โ โโโ player.py # Handles the core functionality of the music player.
-โ โโโ ui/ # Manages the tui interface.
-โ โโโ utils.py # Contains utility functions and other helper functions.
-โ โโโ hotkeys.py # Defines hotkeys for controlling the music player.
-โโโ tests/
-โ โโโ __init__.py
-โ โโโ test_cli.py
-โ โโโ test_config.py
-โ โโโ test_player.py
-โ โโโ test_ui.py
-โ โโโ test_utils.py
-โโโ LICENSE
-โโโ README.md
-โโโ setup.py # Contains the setup script
-โโโ requirements.txt
+# Install Ethos
+pip install ethos
+
+# Start playing music
+ethos
```
## Installation
@@ -68,3 +141,116 @@ ethos/
### For Distribution:
Coming Soon
+
+## Usage:
+
+[](https://www.youtube.com/watch?v=E1AjSHxe5NU&feature=youtu.be)
+
+### Basic Commands
+
+```bash
+/play