From 15189ad1f97c90f87fccbe02db8064cf706c5bbd Mon Sep 17 00:00:00 2001 From: Hugo Rafael Azevedo Date: Tue, 22 Mar 2022 19:55:04 +0000 Subject: [PATCH 1/4] docs: fix URLs --- README.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index bacc907..2e54d3c 100755 --- a/README.md +++ b/README.md @@ -10,6 +10,10 @@ [![Version](https://img.shields.io/github/release/HRADigital/php-datatypes.svg)](https://github.com/HRADigital/php-datatypes) [![PHP](https://img.shields.io/packagist/php-v/hradigital/php-datatypes.svg)](https://github.com/HRADigital/php-datatypes) +## Code + +In order to learn more about the code, please go [here](https://github.com/HRADigital/php-datatypes/blob/master/src/). + ## About **PHP Datatypes** is meant to provide an easy way to create your Value Objects/Entities/Aggregates, in a fast and platform agnostic way, @@ -21,8 +25,8 @@ that promotes: - Full data serializing - No 3rd party dependency apart from PHP. Clean/Self reliant project. -An Aggregate/Entity/ValueObject that extends [AbstractValueObject](/HRADigital/php-datatypes/blob/master/src/ValueObjects/AbstractValueObject.php) -will be built using predefined/tested [Traits](/HRADigital/php-datatypes/tree/master/src/Traits/Entities) for each of the class attributes, +An Aggregate/Entity/ValueObject that extends [AbstractValueObject](https://github.com/HRADigital/php-datatypes/blob/master/src/ValueObjects/AbstractValueObject.php) +will be built using predefined/tested [Traits](https://github.com/HRADigital/php-datatypes/tree/master/src/Traits/Entities) for each of the class attributes, leaving your class definition cleaned/free for your business logic implementation. This will also allow you to reuse/load your objects with data that can come from a Database, Webservice, Event payload, etc... @@ -30,18 +34,18 @@ This will also allow you to reuse/load your objects with data that can come from Getters/Accessors for class attributes will return ValueObjects instead of primitive types, as much as possible. All these datatypes will also be included in the package, as it doesn't have any dependencies apart from, PHP itself. -To learn how to use this package, please go to [AbstractValueObject](/HRADigital/php-datatypes/blob/master/src/ValueObjects/) documentation. +To learn how to use this package, please go to [AbstractValueObject](https://github.com/HRADigital/php-datatypes/blob/master/src/ValueObjects/) documentation. ### Inspiration -Some of the projects that inspired this one, are mainly [Nikita Popov's Scalar Objects](/nikic/scalar_objects), -but also [Martin Helmich's Scalar Classes](/martin-helmich/php-scalarclasses/) and -[Michael Hall's Datatypes](/themichaelhall/datatypes/). +Some of the projects that inspired this one, are mainly [Nikita Popov's Scalar Objects](https://github.com/nikic/scalar_objects), +but also [Martin Helmich's Scalar Classes](https://github.com/martin-helmich/php-scalarclasses/) and +[Michael Hall's Datatypes](https://github.com/themichaelhall/datatypes/). Due to the "_No 3rd party dependency_" rule, this package will use some simplified versions of more popular datatypes. Some examples are: -- [synfony/string](/symfony/string), for String related manipulations. -- [nesbot/carbon](/briannesbitt/Carbon), for DateTime manipulations. +- [synfony/string](https://github.com/symfony/string), for String related manipulations. +- [nesbot/carbon](https://github.com/briannesbitt/Carbon), for DateTime manipulations. - ... ## Requirements & Installation From 371e8792766e299b3f51295139017a5ca4c4f336 Mon Sep 17 00:00:00 2001 From: Hugo Rafael Azevedo Date: Tue, 22 Mar 2022 19:55:22 +0000 Subject: [PATCH 2/4] docs: add link to usage documentation --- src/README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/README.md b/src/README.md index d5add8d..dcda04d 100755 --- a/src/README.md +++ b/src/README.md @@ -18,3 +18,8 @@ For more information about each type of available object, please read dedicated - [Traits](Traits/) - [ValueObjects](ValueObjects/) - [Web](Web/) + +## Getting started + +If you want to get started with this package, please read +[Abstract Value Object's documentation](https://github.com/HRADigital/php-datatypes/blob/master/src/ValueObjects). From ab107fb1f33b0475547d994045073bcb6a06d050 Mon Sep 17 00:00:00 2001 From: Hugo Rafael Azevedo Date: Tue, 22 Mar 2022 20:48:23 +0000 Subject: [PATCH 3/4] docs: small documentation improvement --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2e54d3c..b7d2d82 100755 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ [![Version](https://img.shields.io/github/release/HRADigital/php-datatypes.svg)](https://github.com/HRADigital/php-datatypes) [![PHP](https://img.shields.io/packagist/php-v/hradigital/php-datatypes.svg)](https://github.com/HRADigital/php-datatypes) -## Code +## Code Usage In order to learn more about the code, please go [here](https://github.com/HRADigital/php-datatypes/blob/master/src/). From 977671aa349c7e30392ce6b67cfe071e1fb713e2 Mon Sep 17 00:00:00 2001 From: Hugo Rafael Azevedo Date: Tue, 22 Mar 2022 20:58:15 +0000 Subject: [PATCH 4/4] docs; small documentaiton fix --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b7d2d82..5a88a1b 100755 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ ## Code Usage -In order to learn more about the code, please go [here](https://github.com/HRADigital/php-datatypes/blob/master/src/). +In order to learn more about the code, please go [here](https://github.com/HRADigital/php-datatypes/blob/master/src/ValueObjects). ## About