Skip to content

Commit a9b0f52

Browse files
committed
docs: update readme.md
1 parent 8f1246e commit a9b0f52

File tree

1 file changed

+24
-9
lines changed

1 file changed

+24
-9
lines changed

README.md

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,37 @@
1-
# react-native-audio-analyzer
1+
# react-native-audio-analyzer 🎵
22

3-
## Installation
3+
A powerful library designed for React Native to visualize audio tracks, extract amplitude data, and create stunning audio waveforms.
4+
5+
This package offers robust tools that enable developers to process audio files efficiently, obtaining amplitude arrays for in-depth analysis or creating visually appealing audio waveforms within React Native applications.
6+
7+
## Installation 🚀
48

59
```sh
610
yarn add react-native-audio-analyzer
711
cd ios && pod install
812
```
913

10-
## Images
14+
## Create Stunning Audio Waveforms 🌊
15+
16+
With this library, unleash creativity by generating captivating audio waveforms from your audio tracks, providing an engaging visual representation of sound.
1117

1218
<p float="left">
1319
<img src="images/android.png" width="200" alt="android"/>
1420
<img src="images/ios.png" width="200" alt="ios"/>
1521
</p>
1622

23+
## Features ✨
24+
25+
- __Audio Analysis__: Easily analyze audio tracks to obtain amplitude data for visualization or analysis purposes.
26+
27+
- __Flexible Visualization__: Visualize amplitude data in a customizable manner, allowing developers to create diverse representations based on audio characteristics, including stunning audio waveforms.
1728

18-
## Usage
29+
- __Sample and Scale Data__: Utilize functions to sample and scale amplitude data, providing more granular control over visualization output.
30+
31+
- __Platform Compatibility__: Compatible with both Android and iOS platforms, ensuring a consistent experience across devices.
32+
33+
34+
## Usage 🎶
1935

2036
```js
2137
import React, { useState } from 'react';
@@ -85,10 +101,9 @@ const styles = StyleSheet.create({
85101

86102
```
87103

88-
## Contributing
89-
90-
See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
104+
## Contributing 🤝
105+
We welcome [contributions](CONTRIBUTING.md)! Learn more about how to contribute to this repository by checking out our contributing guide and development workflow.
91106

92-
## License
107+
## License 📝
108+
This project is licensed under the MIT License.
93109

94-
MIT

0 commit comments

Comments
 (0)