chore(docs): update readme

LICENSE.md

@@ -1,21 +1,22 @@
-The MIT License (MIT)
+# BSD 3-Clause License
 
-Copyright (c) Hearth <[email protected]>
+Copyright (c) 2024, OCAD University. All rights reserved.
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
+following conditions are met:
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
+disclaimer in the documentation and/or other materials provided with the distribution.
+
+Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products
+derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -3,17 +3,10 @@
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/fluid-project/hearth-components.svg?style=flat-square)](https://packagist.org/packages/fluid-project/hearth-components)
 [![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/fluid-project/hearth-components/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/fluid-project/hearth-components/actions?query=workflow%3Arun-tests+branch%3Amain)
 [![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/fluid-project/hearth-components/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/fluid-project/hearth-components/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
+[![Code Coverage](https://codecov.io/gh/fluid-project/hearth-components/graph/badge.svg?token=1J9DQ6F2QT)](https://codecov.io/gh/fluid-project/hearth-components)
 [![Total Downloads](https://img.shields.io/packagist/dt/fluid-project/hearth-components.svg?style=flat-square)](https://packagist.org/packages/fluid-project/hearth-components)
 
-This is where your description should go. 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/hearth-components.jpg?t=1" width="419px" />](https://spatie.be/github-ad-click/hearth-components)
-
-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).
+Robust components for the Laravel Framework.
 
 ## Installation
 
@@ -23,26 +16,6 @@ You can install the package via composer:
 composer require fluid-project/hearth-components
 ```
 
-You can publish and run the migrations with:
-
-```bash
-php artisan vendor:publish --tag="hearth-components-migrations"
-php artisan migrate
-```
-
-You can publish the config file with:
-
-```bash
-php artisan vendor:publish --tag="hearth-components-config"
-```
-
-This is the contents of the published config file:
-
-```php
-return [
-];
-```
-
 Optionally, you can publish the views using
 
 ```bash
@@ -51,10 +24,7 @@ php artisan vendor:publish --tag="hearth-components-views"
 
 ## Usage
 
-```php
-$hearth = new Hearth\Hearth();
-echo $hearth->echoPhrase('Hello, Hearth!');
-```
+TODO.
 
 ## Testing
 
@@ -68,17 +38,16 @@ Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed re
 
 ## Contributing
 
-Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
+Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
 
 ## Security Vulnerabilities
 
-Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
+Please review [our security policy](.github/SECURITY.md) on how to report security vulnerabilities.
 
 ## Credits
 
 - [OCAD University](https://github.com/fluid-project)
-- [All Contributors](../../contributors)
 
 ## License
 
-The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
+The BSD 3-Clause License. Please see [License File](LICENSE.md) for more information.

composer.json

@@ -1,13 +1,14 @@
 {
     "name": "fluid-project/hearth-components",
-    "description": "This is my package hearth-components",
+    "description": "Robust components for the Laravel Framework.",
     "keywords": [
-        "Hearth",
+        "hearth",
         "laravel",
-        "hearth-components"
+        "blade",
+        "components"
     ],
     "homepage": "https://github.com/fluid-project/hearth-components",
-    "license": "MIT",
+    "license": "BSD-3-Clause",
     "authors": [
         {
             "name": "OCAD University",