Skip to content

Commit 9c6b0c1

Browse files
committed
chore: read.me
1 parent 207ea72 commit 9c6b0c1

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,25 @@ or
1414
yarn add react-native-outline-vpn
1515
```
1616

17-
Documentation page: https://rn-outline.vercel.app/
17+
```tsx copy
18+
import Outline from 'react-native-outline-vpn';
19+
// THIS VPN INFORMATIONS INTENTIONALLY LEFT EXPOSED, HAS 0 MB LIMIT SO CANNOT ACCESS INTERNET BUT COULD BE USE FOR TEST VPN CONNECTION
20+
Outline.startVpn({
21+
host:'185.218.124.25',
22+
port: 42248,
23+
password: 'FQZV7mWkAB3l7pzg7tpv9p',
24+
method: 'chacha20-ietf-poly1305',
25+
prefix: '\u0005\u00DC\u005F\u00E0\u0001\u0020', //vpn prefix
26+
providerBundleIdentifier: 'org.reactjs.native.example.OutlineVpnExample.OutlineVpn', //apple bundle identifier declared step-2 on guide
27+
serverAddress: 'OutlineServer', //can be any string which user see MyPreciousVpn
28+
tunnelId: 'OutlineTunnel', //can be random string
29+
localizedDescription: 'OutlineVpn', //can be random string
30+
});
31+
```
32+
33+
> Android hasn't need any additional configuration, but iOS needs some additional configuration. Please check the [documentation](https://rn-outline.vercel.app/) for more information.
34+
35+
Detailed documentation page: [Documantation](https://rn-outline.vercel.app/)
1836

1937
## Contributing
2038

0 commit comments

Comments
 (0)