Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
grishkovelli committed Oct 5, 2018
1 parent 52b7dfe commit 420cf2e
Showing 1 changed file with 3 additions and 12 deletions.
15 changes: 3 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
- A lot of callbacks
- Individual an audio player

### Tested in
### Tested in (desktop)

- Chrome
- Firefox
Expand All @@ -33,6 +33,7 @@ npm i vue-audio-recorder --save
| --------------------- | -------- | --------------------------------------------------------------- |
| attempts | Number | Number of recording attempts |
| compact | Boolean | Hide the download and upload buttons |
| headers | Object | HTTP headers |
| time | Number | Time limit for the record (minutes) |
| upload-url | String | URL for uploading |
| start-record | Function | Fires after click the record button |
Expand All @@ -52,17 +53,6 @@ npm i vue-audio-recorder --save

## Usage

The most common use case is to register the component globally

```js
import {AudioRecorder, AudioPlayer} from 'vue-audio-recorder'

Vue.component(AudioPlayer)
Vue.component(AudioRecorder)
```

Alternatively you can do this to register the components

```js
import AudioRecorder from 'vue-audio-recorder'

Expand All @@ -73,6 +63,7 @@ Alternatively you can do this to register the components
<audio-recorder
upload-url="YOUR_API_URL"
:attempts="3"
:headers="headers"
:time="2"
:start-record="callback"
:stop-record="callback"
Expand Down

0 comments on commit 420cf2e

Please sign in to comment.