doc: getting started: improve examples (#154)

add example for default lib qr provider and add issuer too

see #152

.github/workflows/test-bacon.yml

@@ -10,11 +10,16 @@ jobs:
 
     strategy:
       matrix:
-        php-version: ['8.2', '8.3']
-        bacon-version: ['^2', '^3']
+        php-version: [8.2, 8.3, 8.4, 8.5]
+        bacon-version: ["^2", "^3"]
+        exclude:
+          - php-version: 8.4
+            bacon-version: "^2"
+          - php-version: 8.5
+            bacon-version: "^2"
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
 
     - uses: shivammathur/setup-php@v2
       with:

.github/workflows/test-endroid.yml

@@ -10,11 +10,24 @@ jobs:
 
     strategy:
       matrix:
-        php-version: ['8.2', '8.3']
-        endroid-version: ["^3","^4","^5","^6"]
+        php-version: [8.2, 8.3, 8.4, 8.5]
+        endroid-version: ["^3", "^4", "^5", "^6"]
+        exclude:
+          - php-version: 8.4
+            endroid-version: "^3"
+          - php-version: 8.4
+            endroid-version: "^4"
+          - php-version: 8.4
+            endroid-version: "^5"
+          - php-version: 8.5
+            endroid-version: "^3"
+          - php-version: 8.5
+            endroid-version: "^4"
+          - php-version: 8.5
+            endroid-version: "^5"
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
 
     - uses: shivammathur/setup-php@v2
       with:

.github/workflows/test.yml

@@ -10,10 +10,10 @@ jobs:
 
     strategy:
       matrix:
-        php-version: ['8.2', '8.3']
+        php-version: [8.2, 8.3, 8.4, 8.5]
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
 
     - uses: shivammathur/setup-php@v2
       with:

README.md

@@ -33,7 +33,7 @@ If you need more in-depth information about the configuration available then you
 
 ## Integrations
 
-- [CakePHP 3](https://github.com/andrej-griniuk/cakephp-two-factor-auth)
+- [CakePHP plugin](https://github.com/andrej-griniuk/cakephp-two-factor-auth)
 - [CI4-Auth: a user, group, role and permission management library for Codeigniter 4](https://github.com/glewe/ci4-auth)
 
 ## License

demo/demo.php

@@ -11,8 +11,10 @@
                 include_once str_replace(array('RobThree\\Auth', '\\'), array(__DIR__.'/../lib', '/'), $className) . '.php';
             });
 
-            // substitute your company or app name here
-            $tfa = new RobThree\Auth\TwoFactorAuth(new RobThree\Auth\Providers\Qr\QRServerProvider());
+            $tfa = new RobThree\Auth\TwoFactorAuth(
+                new RobThree\Auth\Providers\Qr\QRServerProvider(),
+                "Acme Corp" // substitute your company or app name here
+            );
         ?>
         <li>First create a secret and associate it with a user</li>
         <?php

docs/getting-started.md

@@ -21,17 +21,20 @@ Example code:
 
 ```php
 use RobThree\Auth\TwoFactorAuth;
+use RobThree\Auth\Providers\Qr\QRServerProvider; // if using library's provider
 use RobThree\Auth\Providers\Qr\BaconQrCodeProvider; // if using Bacon
 use RobThree\Auth\Providers\Qr\EndroidQrCodeProvider; // if using Endroid
 
+// using the default Qr Code provider from the library
+$tfa = new TwoFactorAuth(new QRServerProvider(), "Your app name");
 // using Bacon
-$tfa = new TwoFactorAuth(new BaconQrCodeProvider());
+$tfa = new TwoFactorAuth(new BaconQrCodeProvider(), "Your app name");
 // using Endroid
-$tfa = new TwoFactorAuth(new EndroidQrCodeProvider());
+$tfa = new TwoFactorAuth(new EndroidQrCodeProvider(), "Your app name");
 // using a custom object implementing IQRCodeProvider interface
-$tfa = new TwoFactorAuth(new MyQrCodeProvider());
+$tfa = new TwoFactorAuth(new MyQrCodeProvider(), "Your app name");
 // using named argument and a variable
-$tfa = new TwoFactorAuth(qrcodeprovider: $qrGenerator);
+$tfa = new TwoFactorAuth(qrcodeprovider: $qrGenerator, issuer: "Your app name");
 ```
 
 ## 3. Shared secrets

lib/Providers/Qr/BaseHTTPQRCodeProvider.php

@@ -26,7 +26,6 @@ abstract class BaseHTTPQRCodeProvider implements IQRCodeProvider
             throw new QRException(curl_error($curlhandle));
         }
 
-        curl_close($curlhandle);
         return $data;
     }
 }

lib/Providers/Qr/EndroidQrCodeWithLogoProvider.php

@@ -33,11 +33,15 @@ class EndroidQrCodeWithLogoProvider extends EndroidQrCodeProvider
 
         $logo = null;
         if ($this->logoPath) {
-            $logo = Logo::create($this->logoPath);
-            if ($this->logoSize) {
-                $logo->setResizeToWidth($this->logoSize[0]);
-                if (isset($this->logoSize[1])) {
-                    $logo->setResizeToHeight($this->logoSize[1]);
+            if ($this->endroid6) {
+                $logo = new Logo($this->logoPath, ...$this->logoSize);
+            } else {
+                $logo = Logo::create($this->logoPath);
+                if ($this->logoSize) {
+                    $logo->setResizeToWidth($this->logoSize[0]);
+                    if (isset($this->logoSize[1])) {
+                        $logo->setResizeToHeight($this->logoSize[1]);
+                    }
                 }
             }
         }