|
1 | | -# Your Plugin Name |
| 1 | +# Nativescript Carto SDK plugin |
2 | 2 |
|
3 | | -Add your plugin badges here. See [nativescript-urlhandler](https://github.com/hypery2k/nativescript-urlhandler) for example. |
4 | 3 |
|
5 | | -Then describe what's the purpose of your plugin. |
| 4 | +[](https://www.npmjs.com/package/@nativescript-community/ui-carto) |
| 5 | +[](https://www.npmjs.com/package/@nativescript-community/ui-carto) |
| 6 | +[](https://www.npmjs.com/package/@nativescript-community/ui-carto) |
6 | 7 |
|
7 | | -In case you develop UI plugin, this is where you can add some screenshots. |
| 8 | +A NativeScript [Carto SDK](https://carto.com/developers/mobile-sdk/) plugin. |
8 | 9 |
|
9 | | -## (Optional) Prerequisites / Requirements |
10 | | - |
11 | | -Describe the prerequisites that the user need to have installed before using your plugin. See [nativescript-firebase plugin](https://github.com/eddyverbruggen/nativescript-plugin-firebase) for example. |
12 | 10 |
|
13 | 11 | ## Installation |
14 | 12 |
|
15 | | -Describe your plugin installation steps. Ideally it would be something like: |
16 | | - |
17 | | -```javascript |
18 | | -tns plugin add <your-plugin-name> |
| 13 | +```shell |
| 14 | +tns plugin add @nativescript-community/ui-carto |
19 | 15 | ``` |
20 | 16 |
|
21 | 17 | ## Usage |
22 | 18 |
|
23 | | -Describe any usage specifics for your plugin. Give examples for Android, iOS, Angular if needed. See [nativescript-drop-down](https://www.npmjs.com/package/nativescript-drop-down) for example. |
24 | | - |
25 | | - ```javascript |
26 | | - Usage code snippets here |
27 | | - ```) |
28 | | - |
29 | | -### Android |
30 | | -o do this in Android 9 Pie you will have to set a networkSecurityConfig in your Manifest application tag like this: |
31 | | -```xml |
32 | | -<?xml version="1.0" encoding="utf-8"?> |
33 | | -<manifest ... > |
34 | | - <application android:networkSecurityConfig="@xml/network_security_config"> |
35 | | - </application> |
36 | | -</manifest> |
37 | | -``` |
38 | | -Then in your xml folder you now have to create a file named network_security_config just like the way you have named it in the Manifest and from there the content of your file should be like this to enable all requests without encryptions: |
39 | | - |
40 | | -```xml |
41 | | -<?xml version="1.0" encoding="utf-8"?> |
42 | | -<network-security-config> |
43 | | - <base-config cleartextTrafficPermitted="true"> |
44 | | - <trust-anchors> |
45 | | - <certificates src="system" /> |
46 | | - </trust-anchors> |
47 | | - </base-config> |
48 | | -</network-security-config> |
49 | | -``` |
50 | | -From there you are good to go. Now your app will make requests for all types of connections. For additional information read here. |
51 | | - |
52 | | -## Generate typings |
53 | | - |
54 | | -### Android |
55 | | -``` |
56 | | -
|
57 | | -### iOS |
| 19 | +The api doc for this plugin is visible at [https://nativescript-community.github.io/ui-carto/](https://nativescript-community.github.io/ui-carto/) |
58 | 20 |
|
59 | | -## API |
60 | 21 |
|
61 | | -Describe your plugin methods and properties here. See [nativescript-feedback](https://github.com/EddyVerbruggen/nativescript-feedback) for example. |
62 | | - |
63 | | -| Property | Default | Description | |
64 | | -| --- | --- | --- | |
65 | | -| some property | property default value | property description, default values, etc.. | |
66 | | -| another property | property default value | property description, default values, etc.. | |
67 | | - |
68 | 22 | ## License |
69 | 23 |
|
70 | 24 | Apache License Version 2.0, January 2004 |
0 commit comments