Merge pull request #61 from OskarStark/feature/rename-folder

Enhancement: Rename examples folder
slunak · Aug 28, 2024 · 18f1a3f · 18f1a3f
2 parents 73e17b9 + 80eccf9
commit 18f1a3f
Show file tree

Hide file tree

Showing 13 changed files with 13 additions and 13 deletions.
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -93,7 +93,7 @@
     ->append([
         __DIR__.'/.php-cs-fixer.dist.php',
     ])
-    ->in('Example')
+    ->in('examples')
     ->in('src')
     ->in('tests');
 

diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@
 Light, simple and fast, yet comprehensive wrapper for the [Pushover](https://pushover.net/) API.
 
 ### Features
-- Message API ([Example](Example/CompleteNotificationExample.php))
+- Message API ([Example](examples/CompleteNotificationExample.php))
   - Image attachment
   - User's device name(s)
   - Message's title
@@ -18,29 +18,29 @@ Light, simple and fast, yet comprehensive wrapper for the [Pushover](https://pus
   - Notification sound (including custom sound)
   - Message time
   - Time to live
-- User/Group Validation API ([Example](Example/UserGroupValidationExample.php))
+- User/Group Validation API ([Example](examples/UserGroupValidationExample.php))
   - Validation by user or group key
   - Validation by user and device
-- Receipt API ([Example](Example/ReceiptExample.php))
+- Receipt API ([Example](examples/ReceiptExample.php))
   - Query emergency priority receipt
   - Cancel emergency priority retry
-- Groups API ([Example](Example/GroupsExample.php))
+- Groups API ([Example](examples/GroupsExample.php))
   - Create a group
   - List groups
   - Retrieve information about the group
   - Add / Remove users
   - Enable / Disable users
   - Rename the group
-- Glances API ([Example](Example/GlancesExample.php))
+- Glances API ([Example](examples/GlancesExample.php))
   - Title
   - Text
   - Subtext
   - Count
   - Percent
-- Licensing API ([Example](Example/LicensingExample.php))
+- Licensing API ([Example](examples/LicensingExample.php))
   - Check remaining credits
   - Assign license (not tested)
-- Subscription API ([Example](Example/SubscriptionExample.php))
+- Subscription API ([Example](examples/SubscriptionExample.php))
   - User Key Migration 
 
 ## Getting Started
@@ -70,16 +70,16 @@ plus its curl and json extensions. See below the `require` section of project's
 
 ## Pushing Messages
 
-*Note: For more code examples, see [Example](Example) folder in the root of the project. You may also generate and see code documentation.*
+*Note: For more code examples, see [examples](examples) folder in the root of the project. You may also generate and see code documentation.*
 
 Instantiate pushover application and recipient of the notification:
 
 ```php
 use Serhiy\Pushover\Application;
 use Serhiy\Pushover\Recipient;
 
-$application = new Application("replace_with_pushover_application_api_token");
-$recipient = new Recipient("replace_with_pushover_user_key");
+$application = new Application('replace_with_pushover_application_api_token');
+$recipient = new Recipient('replace_with_pushover_user_key');
 ```
 
 Or use Dependency Injection to inject them into the services of your app.
@@ -89,7 +89,7 @@ Compose a message:
 ```php
 use Serhiy\Pushover\Api\Message\Message;
 
-$message = new Message("This is a test message", "This is a title of the message");
+$message = new Message('This is a test message', 'This is a title of the message');
 ```
 
 Create notification:
@@ -109,7 +109,7 @@ $response = $notification->push();
 
 ## Working with response
 
-*Note: For complete example refer to [ResponseExample.php](Example/ResponseExample.php)*
+*Note: For complete example refer to [ResponseExample.php](examples/ResponseExample.php)*
 
 Client returns Response object. Checking if the message was accepted is easy:
 

diff --git a/Example/CompleteNotificationExample.php → examples/CompleteNotificationExample.php b/Example/CompleteNotificationExample.php → examples/CompleteNotificationExample.php
diff --git a/Example/EmergencyNotificationExample.php → examples/EmergencyNotificationExample.php b/Example/EmergencyNotificationExample.php → examples/EmergencyNotificationExample.php
diff --git a/Example/GlancesExample.php → examples/GlancesExample.php b/Example/GlancesExample.php → examples/GlancesExample.php
diff --git a/Example/GroupsExample.php → examples/GroupsExample.php b/Example/GroupsExample.php → examples/GroupsExample.php
diff --git a/Example/HtmlNotificationExample.php → examples/HtmlNotificationExample.php b/Example/HtmlNotificationExample.php → examples/HtmlNotificationExample.php
diff --git a/Example/LicensingExample.php → examples/LicensingExample.php b/Example/LicensingExample.php → examples/LicensingExample.php
diff --git a/Example/ReceiptExample.php → examples/ReceiptExample.php b/Example/ReceiptExample.php → examples/ReceiptExample.php
diff --git a/Example/ResponseExample.php → examples/ResponseExample.php b/Example/ResponseExample.php → examples/ResponseExample.php
diff --git a/Example/SimpleNotificationExample.php → examples/SimpleNotificationExample.php b/Example/SimpleNotificationExample.php → examples/SimpleNotificationExample.php
diff --git a/Example/SubscriptionExample.php → examples/SubscriptionExample.php b/Example/SubscriptionExample.php → examples/SubscriptionExample.php
diff --git a/Example/UserGroupValidationExample.php → examples/UserGroupValidationExample.php b/Example/UserGroupValidationExample.php → examples/UserGroupValidationExample.php