Skip to content

Commit ae68b09

Browse files
committed
updating readme
1 parent 3f6baaf commit ae68b09

File tree

1 file changed

+22
-21
lines changed

1 file changed

+22
-21
lines changed

README.md

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11

22
# react-native-replaykit
3+
# work in progress, breaking changes inbound - WIP
4+
5+
# MIT Licence (See Licences folder)
36

47
## Getting started
58

@@ -9,24 +12,8 @@
912

1013
`$ react-native link react-native-replaykit`
1114

12-
### Usage
13-
14-
```
15-
import RNRK from 'react-native-replaykit'
16-
17-
RNRK.startRecording() // starts the recording
18-
19-
RNRK.stopRecording() // stops the recording and saves it <- Same as pressing Stop in blue bar up top
20-
21-
RKRK.getRecordings(recordings => console.log(recordings)) get all recordings stored in the app's Documents/Replays folder.
22-
23-
RNRK.previewRecording(path) // open a recording for trimming in the native editor.. save will replace the file, cancel just dismiss the editor.
24-
25-
```
26-
2715
### Manual installation
2816

29-
3017
#### iOS
3118

3219
1. In XCode, in the project navigator, right click `Libraries``Add Files to [your project's name]`
@@ -39,11 +26,25 @@ RNRK.previewRecording(path) // open a recording for trimming in the native edito
3926
Create a swift file in your main project (if anyone knows a better way to get the auto generated swift build settings to show up, plese open an issue). If you delete this swift file or bridging header, the build settings needed will go away and build fail. 'Objecttive-C Generated Interface Header Name'.
4027

4128

42-
## Usage
43-
```javascript
44-
import RNReactNativeReplaykit from 'react-native-replaykit';
29+
### Usage
30+
```
31+
import RNRK from 'react-native-replaykit'
32+
33+
RNRK.startRecording() // starts the recording
4534
46-
// TODO: What to do with the module?
47-
RNReactNativeReplaykit;
35+
RNRK.stopRecording() // stops the recording and saves it <- Same as pressing Stop in blue bar up top
36+
37+
RKRK.getRecordings(recordings => console.log(recordings)) get all recordings stored in the app's Documents/Replays folder.
38+
39+
RNRK.previewRecording(path) // open a recording for trimming in the native editor.. save will replace the file, cancel just dismiss the editor.
4840
```
41+
42+
## Contributing
43+
If you find a bug or would like to request a new feature, open an issue.
44+
Your contributions are always welcome! Fork the project and Submit a pull request.
45+
46+
## TODO
47+
* Utility for Editing multiple saved clips into one
48+
* Utilities for ReplayKit's Broadcasting ability
49+
4950

0 commit comments

Comments
 (0)