Weight conversion

.github/FUNDING.yml

@@ -1 +1 @@
-github: :vendor_name
+github: JacobFitzp

.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/JacobFitzp/weight-conversions/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/JacobFitzp/weight-conversions/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/JacobFitzp/weight-conversions/security/policy
     about: Learn how to notify us for sensitive bugs

CHANGELOG.md

@@ -1,4 +1,4 @@
 # Changelog
 
-All notable changes to `:package_name` will be documented in this file.
+All notable changes to `weight-conversions` 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) JacobFitzp <contact@jacobfitzp.me>
 
 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,41 +1,59 @@
-# :package_description
+# PHP Weight Conversions
 
-[![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)
-[![Tests](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/workflows/run-tests.yml)
-[![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 package can be used as to scaffold a framework agnostic package. Follow these steps to get started:
+[![Latest Version on Packagist](https://img.shields.io/packagist/v/jacobfitzp/weight-conversions.svg?style=flat-square)](https://packagist.org/packages/jacobfitzp/weight-conversions)
+[![Tests](https://img.shields.io/github/actions/workflow/status/jacobfitzp/weight-conversions/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/jacobfitzp/weight-conversions/actions/workflows/run-tests.yml)
+[![Total Downloads](https://img.shields.io/packagist/dt/jacobfitzp/weight-conversions.svg?style=flat-square)](https://packagist.org/packages/jacobfitzp/weight-conversions)
 
-1. Press the "Use 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. Try and limit it to a paragraph or two. Consider adding a small example.
-
-## Support us
-
-[<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)
-
-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).
-
-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).
+Simple PHP package to convert between different units of weight measurement.
 
 ## Installation
 
 You can install the package via composer:
 
 ```bash
-composer require :vendor_slug/:package_slug
+composer require jacobfitzp/weight-conversions
 ```
 
 ## Usage
 
 ```php
-$skeleton = new VendorName\Skeleton();
-echo $skeleton->echoPhrase('Hello, VendorName!');
+// Create a new measurement unit
+$kilograms = new Kilogram();
+
+// Set weight amount
+// Can also be passed to the constructor
+$kilograms->setAmount(5.75);
+
+// Convert to a different unit type
+$ounce = $kilograms->to(Ounce::class);
+
+// Get weight amount
+$ounce->getAmount();
+```
+
+Supported measurement units:
+
+```php
+// Gram
+\JacobFitzp\WeightConversions\Units\Gram::class;
+
+// Kilogram
+\JacobFitzp\WeightConversions\Units\Kilogram::class;
+
+// Milligram
+\JacobFitzp\WeightConversions\Units\Milligram::class;
+
+// Ounce
+\JacobFitzp\WeightConversions\Units\Ounce::class;
+
+// Pound
+\JacobFitzp\WeightConversions\Units\Pound::class;
+
+// Stone
+\JacobFitzp\WeightConversions\Units\Stone::class;
+
+// Ton
+\JacobFitzp\WeightConversions\Units\Ton::class;
 ```
 
 ## Testing
@@ -58,7 +76,7 @@ Please review [our security policy](../../security/policy) on how to report secu
 
 ## Credits
 
-- [:author_name](https://github.com/:author_username)
+- [Jacob Fitzpatrick](https://github.com/JacobFitzp)
 - [All Contributors](../../contributors)
 
 ## License

composer.json

@@ -1,45 +1,46 @@
 {
-    "name": ":vendor_slug/:package_slug",
-    "description": ":package_description",
+    "name": "jacobfitzp/weight-conversions",
+    "description": "This is my package weight-conversions",
     "keywords": [
-        ":vendor_name",
-        ":package_slug"
+        "JacobFitzp",
+        "weight-conversions"
     ],
-    "homepage": "https://github.com/:vendor_slug/:package_slug",
+    "homepage": "https://github.com/jacobfitzp/weight-conversions",
     "license": "MIT",
     "authors": [
         {
-            "name": ":author_name",
-            "email": "author@domain.com",
+            "name": "Jacob Fitzpatrick",
+            "email": "contact@jacobfitzp.me",
             "role": "Developer"
         }
     ],
     "require": {
         "php": "^8.1"
     },
     "require-dev": {
-        :require_dev_testing,
-        :require_dev_codestyle,
+        "phpunit/phpunit": "^9.5",
+        "friendsofphp/php-cs-fixer": "^3.13",
         "spatie/ray": "^1.28"
     },
     "autoload": {
         "psr-4": {
-            "VendorName\\Skeleton\\": "src"
+            "JacobFitzp\\WeightConversions\\": "src"
         }
     },
     "autoload-dev": {
         "psr-4": {
-            "VendorName\\Skeleton\\Tests\\": "tests"
+            "JacobFitzp\\WeightConversions\\Tests\\": "tests"
         }
     },
     "scripts": {
-        :scripts_testing,
-        :scripts_codestyle
+        "test": "vendor/bin/phpunit",
+            "test-coverage": "vendor/bin/phpunit --coverage",
+        "format": "vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.dist.php --allow-risky=yes"
     },
     "config": {
         "sort-packages": true,
         "allow-plugins": {
-            :plugins_testing,
+
             "phpstan/extension-installer": true
         }
     },