initial commit

.github/FUNDING.yml

@@ -1 +1 @@
-github: :vendor_name
+github: ziming

.github/ISSUE_TEMPLATE/config.yml

@@ -1,11 +1,11 @@
 blank_issues_enabled: false
 contact_links:
   - name: Ask a question
-    url: https://github.com/:vendor_name/:package_name/discussions/new?category=q-a
+    url: https://github.com/ziming/laravel-email-sniper-link/discussions/new?category=q-a
     about: Ask the community for help
   - name: Request a feature
-    url: https://github.com/:vendor_name/:package_name/discussions/new?category=ideas
+    url: https://github.com/ziming/laravel-email-sniper-link/discussions/new?category=ideas
     about: Share ideas for new features
   - name: Report a security issue
-    url: https://github.com/:vendor_name/:package_name/security/policy
+    url: https://github.com/ziming/laravel-email-sniper-link/security/policy
     about: Learn how to notify us for sensitive bugs

CHANGELOG.md

@@ -1,3 +1,3 @@
 # Changelog
 
-All notable changes to `:package_name` will be documented in this file.
+All notable changes to `laravel-email-sniper-link` will be documented in this file.

LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) :vendor_name <author@domain.com>
+Copyright (c) ziming <ziming@users.noreply.github.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,69 +1,52 @@
-# :package_description
-
-[![Latest Version on Packagist](https://img.shields.io/packagist/v/:vendor_slug/:package_slug.svg?style=flat-square)](https://packagist.org/packages/:vendor_slug/:package_slug)
-[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/:vendor_slug/:package_slug/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/:vendor_slug/:package_slug/actions?query=workflow%3Arun-tests+branch%3Amain)
-[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/:vendor_slug/:package_slug/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/:vendor_slug/:package_slug/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
-[![Total Downloads](https://img.shields.io/packagist/dt/:vendor_slug/:package_slug.svg?style=flat-square)](https://packagist.org/packages/:vendor_slug/:package_slug)
-<!--delete-->
----
-This repo can be used to scaffold a Laravel package. Follow these steps to get started:
-
-1. Press the "Use this template" button at the top of this repo to create a new repo with the contents of this skeleton.
-2. Run "php ./configure.php" to run a script that will replace all placeholders throughout all the files.
-3. Have fun creating your package.
-4. If you need help creating a package, consider picking up our <a href="https://laravelpackage.training">Laravel Package Training</a> video course.
----
-<!--/delete-->
-This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
+# Laravel Email Sniper Link
 
-## Support us
+[![Latest Version on Packagist](https://img.shields.io/packagist/v/ziming/laravel-email-sniper-link.svg?style=flat-square)](https://packagist.org/packages/ziming/laravel-email-sniper-link)
+[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/ziming/laravel-email-sniper-link/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/ziming/laravel-email-sniper-link/actions?query=workflow%3Arun-tests+branch%3Amain)
+[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/ziming/laravel-email-sniper-link/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/ziming/laravel-email-sniper-link/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
+[![Total Downloads](https://img.shields.io/packagist/dt/ziming/laravel-email-sniper-link.svg?style=flat-square)](https://packagist.org/packages/ziming/laravel-email-sniper-link)
 
-[<img src="https://github-ads.s3.eu-central-1.amazonaws.com/:package_name.jpg?t=1" width="419px" />](https://spatie.be/github-ad-click/:package_name)
+This package helps you generate a sniper link for your email. Which makes it a lot easier for people to find your email.
 
-We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
+For a quick explainer on what is an email sniper link, you can check out this link below.
 
-We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
+https://growth.design/sniper-link
 
-## Installation
+A common use case is for your verify email page.
 
-You can install the package via composer:
+This package currently generate email sniper links for
+- Google Mail
+- Outlook
+- Yahoo Mail
+- Proton Mail
+- iCloud Mail
 
-```bash
-composer require :vendor_slug/:package_slug
-```
+## Support us
 
-You can publish and run the migrations with:
+You can make a donation or make a PR
 
-```bash
-php artisan vendor:publish --tag=":package_slug-migrations"
-php artisan migrate
-```
+## Installation
 
-You can publish the config file with:
+You can install the package via composer:
 
 ```bash
-php artisan vendor:publish --tag=":package_slug-config"
+composer require ziming/laravel-email-sniper-link
 ```
 
-This is the contents of the published config file:
+## Usage
 
 ```php
-return [
-];
-```
+use Ziming\LaravelEmailSniperLink\LaravelEmailSniperLink;
 
-Optionally, you can publish the views using
+// This just do a quick guess based on the ending email address such as gmail.com, outlook.com, icloud.com etc.
+LaravelEmailSniperLink::getSniperLinkQuick('receiver@gmail.com', 'optional-from-email-that-proton-mail-uses@gmail.com')
 
-```bash
-php artisan vendor:publish --tag=":package_slug-views"
+// This will do a more accurate guess by not only checking the ending email address but also the MX record of the email address
+// if the email address domain is not 1 of the common ones.
+// Which is more useful for business emails. But it does make network calls to fetch the MX records so it is slower
+LaravelEmailSniperLink::getSniperLink('receiver@gmail.com', 'optional-from-email@gmail.com')
 ```
 
-## Usage
-
-```php
-$variable = new VendorName\Skeleton();
-echo $variable->echoPhrase('Hello, VendorName!');
-```
+In the future I may add helper functions. The `LaravelEmailSniperLink` class has more static methods as well which might be useful for you
 
 ## Testing
 
@@ -85,7 +68,7 @@ Please review [our security policy](../../security/policy) on how to report secu
 
 ## Credits
 
-- [:author_name](https://github.com/:author_username)
+- [ziming](https://github.com/ziming)
 - [All Contributors](../../contributors)
 
 ## License

composer.json

@@ -1,24 +1,25 @@
 {
-    "name": ":vendor_slug/:package_slug",
-    "description": ":package_description",
+    "name": "ziming/laravel-email-sniper-link",
+    "description": "This is my package laravel-email-sniper-link",
     "keywords": [
-        ":vendor_name",
+        "ziming",
         "laravel",
-        ":package_slug"
+        "laravel-email-sniper-link"
     ],
-    "homepage": "https://github.com/:vendor_slug/:package_slug",
+    "homepage": "https://github.com/ziming/laravel-email-sniper-link",
     "license": "MIT",
     "authors": [
         {
-            "name": ":author_name",
-            "email": "author@domain.com",
-            "role": "Developer"
+            "name": "ziming",
+            "email": "ziming.opensource@gmail.com",
+            "role": "Package Uploader"
         }
     ],
     "require": {
         "php": "^8.1",
-        "spatie/laravel-package-tools": "^1.14.0",
-        "illuminate/contracts": "^10.0"
+        "illuminate/contracts": "^10.0",
+        "mobiledetect/mobiledetectlib": "^4.8",
+        "spatie/laravel-package-tools": "^1.14.0"
     },
     "require-dev": {
         "laravel/pint": "^1.0",
@@ -35,19 +36,19 @@
     },
     "autoload": {
         "psr-4": {
-            "VendorName\\Skeleton\\": "src/",
-            "VendorName\\Skeleton\\Database\\Factories\\": "database/factories/"
+            "Ziming\\LaravelEmailSniperLink\\": "src/",
+            "Ziming\\LaravelEmailSniperLink\\Database\\Factories\\": "database/factories/"
         }
     },
     "autoload-dev": {
         "psr-4": {
-            "VendorName\\Skeleton\\Tests\\": "tests/",
+            "Ziming\\LaravelEmailSniperLink\\Tests\\": "tests/",
             "Workbench\\App\\": "workbench/app/"
         }
     },
     "scripts": {
         "post-autoload-dump": "@composer run prepare",
-        "clear": "@php vendor/bin/testbench package:purge-skeleton --ansi",
+        "clear": "@php vendor/bin/testbench package:purge-laravel-email-sniper-link --ansi",
         "prepare": "@php vendor/bin/testbench package:discover --ansi",
         "build": [
             "@composer run prepare",
@@ -73,10 +74,10 @@
     "extra": {
         "laravel": {
             "providers": [
-                "VendorName\\Skeleton\\SkeletonServiceProvider"
+                "Ziming\\LaravelEmailSniperLink\\LaravelEmailSniperLinkServiceProvider"
             ],
             "aliases": {
-                "Skeleton": "VendorName\\Skeleton\\Facades\\Skeleton"
+                "LaravelEmailSniperLink": "Ziming\\LaravelEmailSniperLink\\Facades\\LaravelEmailSniperLink"
             }
         }
     },

config/email-sniper-link.php

@@ -0,0 +1,6 @@
+<?php
+
+// config for Ziming/LaravelEmailSniperLink
+return [
+
+];