Skip to content

Commit 2466544

Browse files
committed
chore: readme
1 parent 88e5e9d commit 2466544

File tree

1 file changed

+9
-64
lines changed

1 file changed

+9
-64
lines changed

README.md

+9-64
Original file line numberDiff line numberDiff line change
@@ -1,70 +1,15 @@
11
# Your Plugin Name
22

3-
Add your plugin badges here. See [nativescript-urlhandler](https://github.com/hypery2k/nativescript-urlhandler) for example.
3+
Experimental plugin to draw charts using nativescript-canvas. It is a direct JS port of [MPAndroidChart](https://github.com/PhilJay/MPAndroidChart)
44

5-
Then describe what's the purpose of your plugin.
5+
The main goal was to prevent the need for marshalling all datasets. This is extremelly heavy, costly and uncessary!
66

7-
In case you develop UI plugin, this is where you can add some screenshots.
7+
The demo_vue app show the power of the future plugin:
88

9-
## (Optional) Prerequisites / Requirements
9+
* It is the fastest drawing library in comparaison to ```nativescript-ui-chart``` and ```nativescript-mpchart```. This is due to:
10+
- do not marshal or recreate any subset of the data sets. Directly uses the provided array.
11+
- can share the same data array beetween multiple datasets
12+
- still use the power of native arrays to NOT marshal arrays of positions while drawing lines with ```nativescript-canvas```
13+
* Same JS codebase for iOS and Android. Makes maintaining the library very easy.
14+
* smaller apps size because no native libs or no native framework. All done with the power of {N}
1015

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-
13-
## Installation
14-
15-
Describe your plugin installation steps. Ideally it would be something like:
16-
17-
```javascript
18-
tns plugin add <your-plugin-name>
19-
```
20-
21-
## Usage
22-
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
58-
59-
## API
60-
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-
## License
69-
70-
Apache License Version 2.0, January 2004

0 commit comments

Comments
 (0)