Skip to content

Commit 9d13dd1

Browse files
README: update name and add install cmd
1 parent 23a3af3 commit 9d13dd1

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
1-
# iOS Silent Hack
1+
# iOS Silent Bypass
22

3-
iOS Silent Hack is a library that allows you to play audio context even if the user has the Silent switch on.
3+
iOS Silent Bypass is a library that allows you to play audio context even if the user has the Silent switch on.
44
You'll need to wait for an user interaction to check if the audio context is allowed.
55

66
## Usage
77

8+
```bash
9+
npm install @activetheory/ios-silent-bypass
10+
```
11+
812
```js
9-
import SilentHack from '@activetheory/ios-silent-hack';
13+
import SilentHack from '@activetheory/ios-silent-bypass';
1014

1115
const silentHack = new SilentHack();
1216

@@ -16,3 +20,7 @@ console.log(silentHack.allowed);
1620
// if you want to remove the event listeners after the audio context is allowed, you can call the destroy method
1721
silentHack.destroy();
1822
```
23+
24+
## License
25+
26+
MIT

0 commit comments

Comments
 (0)