Merge pull request #2 from capacitor-community/chore/additions-to-rel…

…ease-1.0.0

chore: additions to release 1.0.0

.eslintignore

@@ -1,3 +1,2 @@
 build
 dist
-example-app

.npmrc

@@ -0,0 +1 @@
+engine-strict=false

.nvmrc

@@ -0,0 +1 @@
+20.11.1

CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## v6.0.0
+
+- initial release

README.md

@@ -1,5 +1,5 @@
 <p align="center"><br><img src="https://user-images.githubusercontent.com/236501/85893648-1c92e880-b7a8-11ea-926d-95355b8175c7.png" width="128" height="128" /></p>
-<h3 align="center">Device Security Detect</h3>
+<h3 align="center">Device Security Detect Plugin</h3>
 <p align="center"><strong><code>@capacitor-community/device-security-detect</code></strong></p>
 <p align="center">
   The Device Security Detect plugin is designed to provide comprehensive device security detection capabilities for Capacitor-based applications. It aims to detect the device has been rooted (Android) or jailbroken (iOS). By using this plugin, developers can enhance the security of their applications and take appropriate actions based on the detected security status.
@@ -17,13 +17,28 @@
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 </p>
 
+## Table of Contents
+
+- [Maintainers](#maintainers)
+- [Plugin versions](#plugin-versions)
+- [Supported Platforms](#supported-platforms)
+- [Installation](#installation)
+- [API](#api)
+- [Usage](#usage)
+
 ## Maintainers
 
 | Maintainer | GitHub                              | Active |
 | ---------- | -------------------------------     | ------ |
 | 4ooper     | [4ooper](https://github.com/4ooper) | yes    |
 | ryaa       | [ryaa](https://github.com/ryaa)     | yes    |
 
+## Plugin versions
+
+| Capacitor version | Plugin version |
+| ----------------- | -------------- |
+| 6.x               | 6.x            |
+
 ## Supported Platforms
 
 - iOS
@@ -58,3 +73,13 @@ isJailBreakOrRooted() => Promise<{ value: boolean; }>
 --------------------
 
 </docgen-api>
+
+## Usage
+
+### Detect if the device has been rooted (Android) or jailbroken (iOS)
+
+```
+import { DeviceSecurityDetect } from '@capacitor-community/device-security-detect';
+
+const { value } = await DeviceSecurityDetect.isJailBreakOrRooted();
+```