Skip to content

Commit

Permalink
Add License🔑, Update README.md and fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
thehanimo committed Jan 8, 2021
1 parent 39f7f25 commit 255f5d3
Show file tree
Hide file tree
Showing 6 changed files with 75 additions and 4,559 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
node_modules/
npm-debug.log
yarn-error.log
yarn.lock

# Xcode
#
Expand Down
21 changes: 21 additions & 0 deletions LICENSE
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.
52 changes: 44 additions & 8 deletions README.md
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

Expand All @@ -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
16 changes: 7 additions & 9 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
{
"name": "@thehanimo/react-native-audiokit",
"title": "React Native AudioKit",
"version": "1.0.2",
"description": "A react-native wrapper for AudioKit",
"version": "1.0.4",
"description": "Exposes AudioKit for iOS to React Native.",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
Expand All @@ -14,13 +13,12 @@
},
"keywords": [
"react-native",
"react-native-audio",
"react-native-audio-trimmer",
"react-native-audio-ios",
"react-native-audiokit",
"audio",
"audiokit",
"audiokit-ios"
"react-native-audio",
"trimmer",
"audio-trimmer",
"ios",
"react-native-audiokit"
],
"author": {
"name": "Hani Mohammed",
Expand Down
6 changes: 2 additions & 4 deletions react-native-audiokit.podspec
Original file line number Diff line number Diff line change
Expand Up @@ -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

Loading

0 comments on commit 255f5d3

Please sign in to comment.