Skip to content

Commit

Permalink
Modify README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lilmistake committed Dec 21, 2023
1 parent 00f9672 commit 01ade8c
Showing 1 changed file with 31 additions and 10 deletions.
41 changes: 31 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,37 @@
# soundbox
<p align="center">
<img src="https://i.imgur.com/DaLjcrT.png" alt="SoundBox Logo" width="50%"/>

A new Flutter project.
</p>

## Getting Started
# SoundBox

This project is a starting point for a Flutter application.
SoundBox is a music streaming app that leverages the capabilities of `youtube_explode_dart` and the Unofficial Jio Saavn API from saavn.me to provide an extensive collection of music to its users.

A few resources to get you started if this is your first Flutter project:
## Installation

- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
To install SoundBox, you will need Flutter. Ensure you have the latest version of Flutter installed on your system.

For help getting started with Flutter development, view the
[online documentation](https://docs.flutter.dev/), which offers tutorials,
samples, guidance on mobile development, and a full API reference.
1. Clone the SoundBox repository:
```bash
git clone https://github.com/your-username/soundbox.git
```
2. Navigate to the cloned directory:
```bash
cd soundbox
```
3. Install dependencies:
```bash
flutter pub get
```

## Requirements

- Flutter SDK: >=3.2.3 <4.0.0

## Disclaimer

This project, "SoundBox," is developed for educational and personal use only. It utilizes `youtube_explode_dart` and the Unofficial Jio Saavn API, which are not officially endorsed or maintained by YouTube or Jio Saavn. The developers of "SoundBox" are not responsible for any misuse of the software.

## License

SoundBox is MIT licensed, as found in the LICENSE file.

0 comments on commit 01ade8c

Please sign in to comment.