Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bobbles911 committed Oct 11, 2023
1 parent 74c5336 commit 590bf3c
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 6 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,9 @@ export default function App() {
viewRecording={viewRecording}
viewError={viewError}/>

{recorder.mp3Urls.map(url =>
<audio key={url} src={url} controls/>
)}
{recorder.mp3Urls.map(url =>
<audio key={url} src={url} controls/>
)}
</div>
);
}
Expand Down Expand Up @@ -235,7 +235,12 @@ Please see the [react hook and component example](examples/react-hook-example) f
#### Importing

```javascript
import {useSimpleAudioRecorder, SimpleAudioRecorder, preloadWorker, RecorderStates} from "simple-audio-recorder/react"
import {
useSimpleAudioRecorder,
SimpleAudioRecorder,
preloadWorker,
RecorderStates
} from "simple-audio-recorder/react"
```

#### useSimpleAudioRecorder hook
Expand Down Expand Up @@ -267,7 +272,7 @@ const {

#### SimpleAudioRecorder component

This is a very simply state machine component that shows a different view component depending on the current recorder state.
This is a very simple state machine component that shows a different view component depending on the current recorder state.

```javascript
SimpleAudioRecorder({
Expand Down
4 changes: 3 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
"recorder",
"mp3",
"encoder",
"microphone"
"microphone",
"react",
"hook"
],
"homepage": "https://github.com/vocaroo/simple-audio-recorder",
"repository": {
Expand Down

0 comments on commit 590bf3c

Please sign in to comment.