-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add License🔑, Update README.md and fixes
- Loading branch information
Showing
6 changed files
with
75 additions
and
4,559 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -7,6 +7,7 @@ | |
node_modules/ | ||
npm-debug.log | ||
yarn-error.log | ||
yarn.lock | ||
|
||
# Xcode | ||
# | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2020-present, Hani Mohammed. | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,50 @@ | ||
# react-native-audiokit | ||
|
||
## ⚠️ iOS ONLY | ||
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) | ||
[![star this repo](https://img.shields.io/github/stars/thehanimo/react-native-audiokit?style=flat-square)](https://github.com/thehanimo/react-native-audiokit) | ||
[![NPM Version](https://img.shields.io/npm/v/@thehanimo/react-native-audiokit.svg?style=flat-square)](https://www.npmjs.com/package/@thehanimo/react-native-audiokit) | ||
[![iOS Only](https://img.shields.io/badge/iOS%20Only--green?logo=apple&style=social)](https://www.npmjs.com/package/@thehanimo/react-native-audiokit) | ||
|
||
This package simply wraps up the AudioKit iOS package. Made this as I couldn't find any proper react-native audio trimming or processing module. Right now, this package only supports trimming. However with AudioKit, the possibilities are endless. [Take a look here!](http://audiokit.io/) | ||
This package simply wraps up the [**AudioKit**](https://github.com/AudioKit/AudioKit) iOS package. Made this as I couldn't find any proper react-native audio trimming or processing module. Right now, this package only supports trimming audio files. However with AudioKit, the possibilities are endless. [Take a look here!](http://audiokit.io/) | ||
|
||
## Getting started | ||
In case you need a new feature added to this project, raise an issue or reach out to me at [[email protected]](mailto:[email protected]) | ||
|
||
`$ npm install @thehanimo/react-native-audiokit --save` | ||
or | ||
`$ yarn add @thehanimo/react-native-audiokit` | ||
<p align="center"> | ||
<a href="https://nodestory.com" target="_blank"> | ||
<img src="https://i.imgur.com/M1iuH1t.gif" title="Nodestory's trimming functionality"/> | ||
</a> | ||
<h6 align="center"><a href="https://nodestory.com" target="_blank">Nodestory</a> uses this module!</h6> | ||
</p> | ||
|
||
### Mostly automatic installation | ||
## Platforms Supported | ||
|
||
`$ react-native link @thehanimo/react-native-audiokit` | ||
- [x] iOS | ||
- [ ] Android | ||
|
||
## Installation (React Native >= 0.60.0) | ||
|
||
1. Install the package | ||
`yarn add @thehanimo/react-native-audiokit` | ||
or | ||
`npm install @thehanimo/react-native-audiokit` | ||
|
||
2. Install pods | ||
|
||
``` | ||
cd ios | ||
pod install | ||
cd .. | ||
``` | ||
|
||
## Installation (React Native <= 0.59.0) | ||
|
||
1. Install the package | ||
`yarn add @thehanimo/react-native-audiokit@1` | ||
or | ||
`npm install @thehanimo/react-native-audiokit@1` | ||
|
||
2. Link the package | ||
`react-native link @thehanimo/react-native-audiokit` | ||
|
||
## Usage | ||
|
||
|
@@ -23,3 +55,7 @@ let newFileName = await RNAudioKit.trimAudio("filename.mp3", 0, 10); // 0 - star | |
// NOTE: filename.mp3 must be located in the documents folder. Not temp. | ||
// newFileName will give you only the name. Append it to the documents directory path. | ||
``` | ||
|
||
## License | ||
|
||
MIT |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -11,16 +11,14 @@ Pod::Spec.new do |s| | |
DESC | ||
s.homepage = "https://github.com/thehanimo/react-native-audiokit" | ||
s.license = "MIT" | ||
s.license = { :type => "MIT", :file => "FILE_LICENSE" } | ||
s.license = { :type => "MIT", :file => "LICENSE" } | ||
s.authors = { "Hani Mohammed" => "[email protected]" } | ||
s.platforms = { :ios => "9.0" } | ||
s.source = { :git => "https://github.com/thehanimo/react-native-audiokit.git", :tag => "#{s.version}" } | ||
|
||
s.source_files = "ios/**/*.{h,m,swift}" | ||
s.source_files = "ios/**/*.{h,m,swift,hpp}" | ||
s.requires_arc = true | ||
|
||
s.dependency "React" | ||
# ... | ||
# s.dependency "..." | ||
end | ||
|
Oops, something went wrong.