remove examples, fix naming

CertificateChecker.podspec → CapacitorSslPinning.podspec

@@ -3,7 +3,7 @@ require 'json'
 package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
 
 Pod::Spec.new do |s|
-  s.name = 'CertificateChecker'
+  s.name = 'CapacitorSslPinning'
   s.version = package['version']
   s.summary = package['description']
   s.license = package['license']

Package.swift

@@ -2,11 +2,11 @@
 import PackageDescription
 
 let package = Package(
-    name: "CertificateChecker",
+    name: "CapacitorSslPinning",
     platforms: [.iOS(.v13)],
     products: [
         .library(
-            name: "CertificateChecker",
+            name: "CapacitorSslPinning",
             targets: ["SSLCertificateCheckerPlugin"])
     ],
     dependencies: [

README.md

@@ -27,7 +27,8 @@ npx cap sync
 
 <docgen-index>
 
-- [`checkCertificate(...)`](#checkcertificate)
+* [`checkCertificate(...)`](#checkcertificate)
+* [Type Aliases](#type-aliases)
 
 </docgen-index>
 
@@ -37,59 +38,29 @@ npx cap sync
 ### checkCertificate(...)
 
 ```typescript
+checkCertificate(options: SSLCertificateCheckerOptions) => Promise<SSLCertificateCheckerResult>
+```
 
-export type SSLCertificateCheckerOptions = {
-  url: string;
-  fingerprint: string;
-};
-
-export type SSLCertificateCheckerResult = {
-  /**
-   * The subject of the certificate
-   * @platform Android
-   */
-  subject?: string;
-  /**
-   * The issuer of the certificate
-   * @platform Android
-   */
-  issuer?: string;
-  /**
-   * The valid from date of the certificate
-   * @platform Android
-   */
-  validFrom?: string;
-  /**
-   * The valid to date of the certificate
-   * @platform Android
-   */
-  validTo?: string;
-  /**
-   * The fingerprint of the certificate
-   * @platform Android
-   */
-  fingerprint?: string;
-  /**
-   * Whether the fingerprint matches the expected fingerprint
-   */
-  fingerprintMatched?: boolean;
-  /**
-   * The error that occurred while checking the certificate
-   */
-  error?: string;
-};
+| Param         | Type                                                                                  |
+| ------------- | ------------------------------------------------------------------------------------- |
+| **`options`** | <code><a href="#sslcertificatecheckeroptions">SSLCertificateCheckerOptions</a></code> |
 
+**Returns:** <code>Promise&lt;<a href="#sslcertificatecheckerresult">SSLCertificateCheckerResult</a>&gt;</code>
 
-checkCertificate(options: SSLCertificateCheckerOptions) => Promise<SSLCertificateCheckerResult>
-```
+--------------------
+
+
+### Type Aliases
+
+
+#### SSLCertificateCheckerResult
+
+<code>{ /** * The subject of the certificate * @platform Android */ subject?: string; /** * The issuer of the certificate * @platform Android */ issuer?: string; /** * The valid from date of the certificate * @platform Android */ validFrom?: string; /** * The valid to date of the certificate * @platform Android */ validTo?: string; /** * The fingerprint of the certificate * @platform Android */ fingerprint?: string; /** * Whether the fingerprint matches the expected fingerprint */ fingerprintMatched?: boolean; /** * The error that occurred while checking the certificate */ error?: string; }</code>
 
-| Param         | Type                                      |
-| ------------- | ----------------------------------------- |
-| **`options`** | <code>SSLCertificateCheckerOptions</code> |
 
-**Returns:** <code>Promise&lt;SSLCertificateCheckerResult&gt;</code>
+#### SSLCertificateCheckerOptions
 
----
+<code>{ url: string; fingerprint: string; }</code>
 
 </docgen-api>
 

android/src/main/java/com/tonybluckdruck/certificatechecker/SSLCertificateChecker.java

@@ -1,4 +1,4 @@
-// android/src/main/java/com/your/plugin/CertificateChecker.java
+// android/src/main/java/com/your/plugin/CapacitorSslPinning.java
 
 package com.tonybluckdruck.certificatechecker;