add readme

This commit is contained in:
2025-11-21 21:02:14 +08:00
parent 70ee50f4d8
commit 67e9af8044
3 changed files with 50 additions and 0 deletions

25
README.md Normal file
View File

@@ -0,0 +1,25 @@
<center>
<img src="README/images/logo.png" height="128px" alt="MeowBox">
<h3>Meow~ Music Go !</h3>
<a href="https://github.com/OmniX-Space/MeowBox-Core/blob/master/LICENSE"><img src="https://img.shields.io/github/license/OmniX-Space/MeowBox-Core?style=flat-square&label=license&color=blue"></a>
<a href="https://github.com/OmniX-Space/MeowBox-Core"><img src="https://img.shields.io/github/stars/OmniX-Space/MeowBox-Core?style=flat-square&label=stars"></a>
<a href="https://github.com/OmniX-Space/MeowBox-Core/releases"><img src="https://img.shields.io/github/v/release/OmniX-Space/MeowBox-Core?style=flat-square&label=release"></a>
<br>
<a href="README.md"><img src="https://img.shields.io/badge/-English-grey.svg?style=popout"></a>
<a href="README/README_zh-CN.md"><img src="https://img.shields.io/badge/-中文(简体)-grey.svg?style=popout"></a>
</center>
# What is MeowBox?
MeowBox is a music streaming server that allows you to stream your favorite music to any device on the internet. It is built using Go programming language and can be easily deployed on any platform that supports Go.
## Features
- Play music from your server
- Music streaming for your embedded devices
- Music library management
- Music search and cache
- User authentication and authorization
- Music collection function
## Supported databases
- MySQL
- PostgreSQL

25
README/README_zh-CN.md Normal file
View File

@@ -0,0 +1,25 @@
<center>
<img src="README/images/logo.png" height="128px" alt="MeowBox">
<h3>喵一下~ 音乐出发!</h3>
<a href="https://github.com/OmniX-Space/MeowBox-Core/blob/master/LICENSE"><img src="https://img.shields.io/github/license/OmniX-Space/MeowBox-Core?style=flat-square&label=license&color=blue"></a>
<a href="https://github.com/OmniX-Space/MeowBox-Core"><img src="https://img.shields.io/github/stars/OmniX-Space/MeowBox-Core?style=flat-square&label=stars"></a>
<a href="https://github.com/OmniX-Space/MeowBox-Core/releases"><img src="https://img.shields.io/github/v/release/OmniX-Space/MeowBox-Core?style=flat-square&label=release"></a>
<br>
<a href="README.md"><img src="https://img.shields.io/badge/-English-grey.svg?style=popout"></a>
<a href="README/README_zh-CN.md"><img src="https://img.shields.io/badge/-中文(简体)-grey.svg?style=popout"></a>
</center>
# 什么是 酷喵音乐盒(MeowBox)
酷喵音乐盒(MeowBox) 是一个开源的音乐串流工具,允许您将您最喜欢的音乐流式传输到互联网上的任何设备。它使用 Go 编程语言构建,可以轻松部署在任何支持 Go 的平台上。
## 功能
- 在线听音乐
- 为嵌入式设备提供音乐串流服务
- 管理音乐库
- 搜索和缓存音乐
- 用户身份验证和授权
- 音乐收藏功能
## 支持的数据库
- MySQL
- PostgreSQL

BIN
README/images/logo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 109 KiB