Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 13 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)

<div style="display: flex; gap: 10px; flex-wrap: wrap; justify-content: center;">
<img src="./assets/home.jpg" alt="Home Screen" style="width: 150px; height: auto;" />
<img src="./assets/track-list.jpg" alt="Track List" style="width: 150px; height: auto;" />
<img src="./assets/player.jpg" alt="Player" style="width: 150px; height: auto;" />
<img src="./assets/album-list.jpg" alt="Album List" style="width: 150px; height: auto;" />
<img src="./assets/artist-list.jpg" alt="Artist List" style="width: 150px; height: auto;" />
</div>

## ✨ Features

Expand Down Expand Up @@ -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
Expand All @@ -56,13 +65,6 @@ Add to `android/app/src/main/AndroidManifest.xml`:
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
```

## 📖 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.
Expand Down
25 changes: 13 additions & 12 deletions README_ZH.md
Original file line number Diff line number Diff line change
@@ -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 库,用于访问本地音乐文件并获取完整的元数据信息。

<div style="display: flex; gap: 10px; flex-wrap: wrap; justify-content: center;">
<img src="./assets/home.jpg" alt="Home Screen" style="width: 150px; height: auto;" />
<img src="./assets/track-list.jpg" alt="Track List" style="width: 150px; height: auto;" />
<img src="./assets/player.jpg" alt="Player" style="width: 150px; height: auto;" />
<img src="./assets/album-list.jpg" alt="Album List" style="width: 150px; height: auto;" />
<img src="./assets/artist-list.jpg" alt="Artist List" style="width: 150px; height: auto;" />
</div>

## ✨ 特性

- 🎵 **丰富元数据** - 访问本地音乐并获取完整元数据,包括歌词
Expand Down Expand Up @@ -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();

// 获取专辑并排序
Expand All @@ -56,13 +64,6 @@ const artists = await getArtistsAsync();
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
```

## 📖 文档

- [📚 完整 API 文档](./docs/)
- [🎯 快速开始](./docs/getting-started)
- [🔧 API 参考](./docs/api)
- [💡 示例](./docs/examples)

## 🤝 贡献

详情请参阅 [CONTRIBUTING.md](CONTRIBUTING.md)。
Expand Down
Binary file added assets/album-list.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/artist-list.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/home.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/player.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/track-list.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading