diff --git a/README.md b/README.md index 4e33050..909cd8e 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,20 @@ # react-native-music-library -[中文版](./README_ZH.md) | [📖 Documentation](./docs/) +[![npm version](https://badge.fury.io/js/@nodefinity%2Freact-native-music-library.svg)](https://badge.fury.io/js/@nodefinity%2Freact-native-music-library) +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) + +[中文](./README_ZH.md) A powerful React Native library for accessing local music files and getting full metadata. Built with React Native's New Architecture (TurboModules) for optimal performance. -[![npm version](https://badge.fury.io/js/@nodefinity%2Freact-native-music-library.svg)](https://badge.fury.io/js/@nodefinity%2Freact-native-music-library) -[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) + +
+ Home Screen + Track List + Player + Album List + Artist List +
## ✨ Features @@ -34,7 +43,7 @@ yarn add @nodefinity/react-native-music-library ```js import { getTracksAsync, getAlbumsAsync, getArtistsAsync } from '@nodefinity/react-native-music-library'; -// Get all tracks +// Get tracks const tracks = await getTracksAsync(); // Get albums with sorting @@ -56,13 +65,6 @@ Add to `android/app/src/main/AndroidManifest.xml`: ``` -## 📖 Documentation - -- [📚 Full API Documentation](./docs/) -- [🎯 Getting Started](./docs/getting-started) -- [🔧 API Reference](./docs/api) -- [💡 Examples](./docs/examples) - ## 🤝 Contributing See [CONTRIBUTING.md](CONTRIBUTING.md) for details. diff --git a/README_ZH.md b/README_ZH.md index 2e7c6e4..8df83d1 100644 --- a/README_ZH.md +++ b/README_ZH.md @@ -1,12 +1,20 @@ # react-native-music-library -[English Version](./README.md) | [📖 文档](./docs/) - -一个功能强大的 React Native 库,用于访问本地音乐文件并获取完整的元数据信息。基于 React Native 新架构(TurboModules)构建,性能卓越。 - [![npm version](https://badge.fury.io/js/@nodefinity%2Freact-native-music-library.svg)](https://badge.fury.io/js/@nodefinity%2Freact-native-music-library) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) +[English](./README.md) + +基于 React Native 新架构(TurboModules)构建的 React Native 库,用于访问本地音乐文件并获取完整的元数据信息。 + +
+ Home Screen + Track List + Player + Album List + Artist List +
+ ## ✨ 特性 - 🎵 **丰富元数据** - 访问本地音乐并获取完整元数据,包括歌词 @@ -34,7 +42,7 @@ yarn add @nodefinity/react-native-music-library ```js import { getTracksAsync, getAlbumsAsync, getArtistsAsync } from '@nodefinity/react-native-music-library'; -// 获取所有曲目 +// 获取曲目 const tracks = await getTracksAsync(); // 获取专辑并排序 @@ -56,13 +64,6 @@ const artists = await getArtistsAsync(); ``` -## 📖 文档 - -- [📚 完整 API 文档](./docs/) -- [🎯 快速开始](./docs/getting-started) -- [🔧 API 参考](./docs/api) -- [💡 示例](./docs/examples) - ## 🤝 贡献 详情请参阅 [CONTRIBUTING.md](CONTRIBUTING.md)。 diff --git a/assets/album-list.jpg b/assets/album-list.jpg new file mode 100644 index 0000000..b6c43be Binary files /dev/null and b/assets/album-list.jpg differ diff --git a/assets/artist-list.jpg b/assets/artist-list.jpg new file mode 100644 index 0000000..f080ee9 Binary files /dev/null and b/assets/artist-list.jpg differ diff --git a/assets/home.jpg b/assets/home.jpg new file mode 100644 index 0000000..e5bddfa Binary files /dev/null and b/assets/home.jpg differ diff --git a/assets/player.jpg b/assets/player.jpg new file mode 100644 index 0000000..754744c Binary files /dev/null and b/assets/player.jpg differ diff --git a/assets/track-list.jpg b/assets/track-list.jpg new file mode 100644 index 0000000..8f9e9cd Binary files /dev/null and b/assets/track-list.jpg differ