Skip to content

Commit b3f928e

Browse files
committed
docs: add example images
1 parent 39db4e9 commit b3f928e

File tree

7 files changed

+26
-23
lines changed

7 files changed

+26
-23
lines changed

README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,20 @@
11
# react-native-music-library
22

3-
[中文版](./README_ZH.md) | [📖 Documentation](./docs/)
3+
[![npm version](https://badge.fury.io/js/@nodefinity%2Freact-native-music-library.svg)](https://badge.fury.io/js/@nodefinity%2Freact-native-music-library)
4+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
5+
6+
[中文](./README_ZH.md)
47

58
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.
69

7-
[![npm version](https://badge.fury.io/js/@nodefinity%2Freact-native-music-library.svg)](https://badge.fury.io/js/@nodefinity%2Freact-native-music-library)
8-
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
10+
11+
<div style="display: flex; gap: 10px; flex-wrap: wrap; justify-content: center;">
12+
<img src="./assets/home.jpg" alt="Home Screen" style="width: 150px; height: auto;" />
13+
<img src="./assets/track-list.jpg" alt="Track List" style="width: 150px; height: auto;" />
14+
<img src="./assets/player.jpg" alt="Player" style="width: 150px; height: auto;" />
15+
<img src="./assets/album-list.jpg" alt="Album List" style="width: 150px; height: auto;" />
16+
<img src="./assets/artist-list.jpg" alt="Artist List" style="width: 150px; height: auto;" />
17+
</div>
918

1019
## ✨ Features
1120

@@ -34,7 +43,7 @@ yarn add @nodefinity/react-native-music-library
3443
```js
3544
import { getTracksAsync, getAlbumsAsync, getArtistsAsync } from '@nodefinity/react-native-music-library';
3645

37-
// Get all tracks
46+
// Get tracks
3847
const tracks = await getTracksAsync();
3948

4049
// Get albums with sorting
@@ -56,13 +65,6 @@ Add to `android/app/src/main/AndroidManifest.xml`:
5665
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
5766
```
5867

59-
## 📖 Documentation
60-
61-
- [📚 Full API Documentation](./docs/)
62-
- [🎯 Getting Started](./docs/getting-started)
63-
- [🔧 API Reference](./docs/api)
64-
- [💡 Examples](./docs/examples)
65-
6668
## 🤝 Contributing
6769

6870
See [CONTRIBUTING.md](CONTRIBUTING.md) for details.

README_ZH.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,20 @@
11
# react-native-music-library
22

3-
[English Version](./README.md) | [📖 文档](./docs/)
4-
5-
一个功能强大的 React Native 库,用于访问本地音乐文件并获取完整的元数据信息。基于 React Native 新架构(TurboModules)构建,性能卓越。
6-
73
[![npm version](https://badge.fury.io/js/@nodefinity%2Freact-native-music-library.svg)](https://badge.fury.io/js/@nodefinity%2Freact-native-music-library)
84
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
95

6+
[English](./README.md)
7+
8+
基于 React Native 新架构(TurboModules)构建的 React Native 库,用于访问本地音乐文件并获取完整的元数据信息。
9+
10+
<div style="display: flex; gap: 10px; flex-wrap: wrap; justify-content: center;">
11+
<img src="./assets/home.jpg" alt="Home Screen" style="width: 150px; height: auto;" />
12+
<img src="./assets/track-list.jpg" alt="Track List" style="width: 150px; height: auto;" />
13+
<img src="./assets/player.jpg" alt="Player" style="width: 150px; height: auto;" />
14+
<img src="./assets/album-list.jpg" alt="Album List" style="width: 150px; height: auto;" />
15+
<img src="./assets/artist-list.jpg" alt="Artist List" style="width: 150px; height: auto;" />
16+
</div>
17+
1018
## ✨ 特性
1119

1220
- 🎵 **丰富元数据** - 访问本地音乐并获取完整元数据,包括歌词
@@ -34,7 +42,7 @@ yarn add @nodefinity/react-native-music-library
3442
```js
3543
import { getTracksAsync, getAlbumsAsync, getArtistsAsync } from '@nodefinity/react-native-music-library';
3644

37-
// 获取所有曲目
45+
// 获取曲目
3846
const tracks = await getTracksAsync();
3947

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

59-
## 📖 文档
60-
61-
- [📚 完整 API 文档](./docs/)
62-
- [🎯 快速开始](./docs/getting-started)
63-
- [🔧 API 参考](./docs/api)
64-
- [💡 示例](./docs/examples)
65-
6667
## 🤝 贡献
6768

6869
详情请参阅 [CONTRIBUTING.md](CONTRIBUTING.md)

assets/album-list.jpg

426 KB
Loading

assets/artist-list.jpg

401 KB
Loading

assets/home.jpg

436 KB
Loading

assets/player.jpg

1.11 MB
Loading

assets/track-list.jpg

501 KB
Loading

0 commit comments

Comments
 (0)