Merge pull request #71 from TomHAnderson/feature/readme

readme

LICENSE

@@ -1,6 +1,7 @@
 The MIT License (MIT)
 
 Copyright (c) 2015 Patrick Brouwers
+Copyright (c) 2024 Tom H Anderson <[email protected]>
 
 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,15 +1,38 @@
+<p align="center">
+    <img src="https://placehold.co/10x10/337ab7/337ab7.png" width="100%" height="15px">
+</p>
+
 Laravel Doctrine Extensions
 ===========================
 
-[![GitHub release](https://img.shields.io/github/release/laravel-doctrine/extensions.svg?style=flat-square)](https://packagist.org/packages/laravel-doctrine/extensions)
-[![Github actions](https://github.com/laravel-doctrine/extensions/workflows/CI/badge.svg?branch=1.x)](https://github.com/laravel-doctrine/extensions/actions?query=workflow%3ACI+branch%3A1.x)
-[![Packagist](https://img.shields.io/packagist/dm/laravel-doctrine/extensions.svg?style=flat-square)](https://packagist.org/packages/laravel-doctrine/extensions)
-[![Packagist](https://img.shields.io/packagist/dt/laravel-doctrine/extensions.svg?style=flat-square)](https://packagist.org/packages/laravel-doctrine/extensions)
+[![Build Status](https://github.com/laravel-doctrine/extensions/actions/workflows/continuous-integration.yml/badge.svg)](https://github.com/laravel-doctrine/extensions/actions/workflows/continuous-integration.yml?query=branch%3A2.0.x)
+[![Code coverage](https://codecov.io/gh/laravel-doctrine/extensions/branch/2.0.x/graph/badge.svg?token=hbyGgWHabZ)](https://codecov.io/gh/laravel-doctrine/extensions)
+[![PHPStan](https://img.shields.io/badge/PHPStan-level%201-brightgreen.svg)](https://img.shields.io/badge/PHPStan-level%201-brightgreen.svg)
+[![Packagist downloads](https://img.shields.io/packagist/dm/laravel-doctrine/extensions.svg?style=flat-square)](https://packagist.org/packages/laravel-doctrine/extensions)
+
+Behavioral and Query/Type Extensions for Laravel Doctrine
+
+Installation
+------------
+
+Via composer:
+
+```bash
+composer require laravel-doctrine/extensions
+```
 
-*Behavioral and Query/Type Extensions for Laravel Doctrine*
 
-Gedmo Extensions
-----------------
+Documentation
+-------------
+
+See [the documentation](https://github.com/laravel-doctrine/extensions/tree/2.0.x/docs) for more information.
+~~Full documentation at https://laravel-doctrine-extensions.readthedocs.io~~
+
+
+Provides
+--------
+
+### Gedmo Extensions
 
 * Blameable
 * IpTraceable
@@ -22,15 +45,14 @@ Gedmo Extensions
 * Tree
 * Uploadable
 
-Beberlei Extensions
--------------------
+### Beberlei Extensions
 
 * Custom datetime functions
 * Custom numeric functions
 * Custom string functions
 
-### Installation
-
-[See the Laravel Doctrine website for instructions](http://www.laraveldoctrine.org/docs/current/extensions/installation)
 
+License
+-------
 
+See [LICENSE](https://github.com/laravel-doctrine/extensions/blob/master/LICENSE).