Skip to content

Commit 9dc02be

Browse files
authored
Merge pull request #108 from johnnypeck/patch-1
Clean up readme a bit
2 parents e997d84 + 92cd945 commit 9dc02be

File tree

1 file changed

+12
-13
lines changed

1 file changed

+12
-13
lines changed

README.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,21 @@ a fully featured PHP data model including:
66
* A set of PHP entities with properties, constants (enum values), getters, setters, adders and removers. The class
77
hierarchy provided by Schema.org will be translated to a PHP class hierarchy with parents as `abstract` classes. The generated
88
code complies with [PSR](http://www.php-fig.org/) coding standards.
9-
* Full high-quality PHPDoc for classes, properties, constants and methods extracted from Schema.org.
9+
* Full, high-quality PHPDoc for classes, properties, constants and methods extracted from Schema.org.
1010
* Doctrine ORM annotation mapping including database columns with type guessing, relations with cardinality guessing, class
1111
inheritance (through the `@AbstractSuperclass` annotation).
1212
* Data validation through [Symfony Validator](https://symfony.com/doc/current/book/validation.html) annotations including
1313
data type validation, enum support (choices) and check for required properties.
1414
* Interfaces and [Doctrine `ResolveTargetEntityListener`](https://doctrine-orm.readthedocs.org/en/latest/cookbook/resolve-target-entity-listener.html)
1515
support.
1616
* Custom PHP namespace support.
17-
* List of values provided by Schema.org with [PHP Enum](https://github.com/myclabs/php-enum) classes.
17+
* List of values provided by [Schema.org](https://schema.org) with [PHP Enum](https://github.com/myclabs/php-enum) classes.
1818

1919
Bonus:
2020

21-
* The code generator is fully configurable and extensible: all features can be deactivated (e.g.: the Doctrine mapping generator)
22-
and custom generator can be added (e.g.: a Doctrine ODM mapping generator).
23-
* The generated code can be used as is in a [Symfony](http://symfony.com) app (but it will work too in a raw PHP project
21+
* The code generator is fully configurable and extensible. All features can be deactivated (e.g., the Doctrine mapping generator)
22+
and a custom generator can be added (e.g., a Doctrine ODM mapping generator).
23+
* The generated code can be used as is in a [Symfony](https://symfony.com) app (but it will work too in a raw PHP project
2424
or any other framework including [Laravel](https://laravel.com) and [Zend Framework](http://framework.zend.com/)).
2525

2626
[![Build Status](https://travis-ci.org/api-platform/schema-generator.svg?branch=master)](https://travis-ci.org/api-platform/schema-generator)
@@ -31,27 +31,26 @@ or any other framework including [Laravel](https://laravel.com) and [Zend Framew
3131

3232
Schema.org is a vocabulary representing common data structures and their relations. Schema.org can be exposed as [JSON-LD](https://en.wikipedia.org/wiki/JSON-LD),
3333
[microdata](https://en.wikipedia.org/wiki/Microdata_(HTML)) and [RDFa](https://en.wikipedia.org/wiki/RDFa).
34-
Extracting semantical data exposed in the Schema.org vocabulary is supported by a growing number of companies including
34+
Extracting semantic data exposed in the Schema.org vocabulary is supported by a growing number of companies including
3535
Google (Search, Gmail), Yahoo!, Bing and Yandex.
3636

3737
## Why use Schema.org data to generate a PHP model?
3838

3939
### Don't Reinvent The Wheel
4040

41-
Data models provided by Schema.org are popular and have been proved efficient. They cover a broad spectrum of topics including
41+
Data models provided by Schema.org are popular and have proved efficient. They cover a broad spectrum of topics including
4242
creative work, e-commerce, event, medicine, social networking, people, postal address, organization, place or review.
43-
Schema.org has its root in [a ton of preexisting well designed vocabularies](http://schema.rdfs.org/mappings.html) and is
44-
successfully used by more and more website and applications.
43+
Schema.org has its roots in [a ton of preexisting well designed vocabularies](http://schema.rdfs.org/mappings.html) and is
44+
successfully used by more and more websites and applications.
4545

4646
Pick up schemas applicable to your application, generate your PHP model, then customize and specialize it to fit your needs.
4747

4848
### Improve SEO and user experience
4949

50-
Adding Schema.org markup to websites and apps increase their ranking in search engines results and enable awesome features
50+
Adding Schema.org markup to websites and apps may increase their ranking in search engine results and enable awesome features
5151
such as [Google Rich Snippets](https://support.google.com/webmasters/answer/99170?hl=en) and [Gmail markup](https://developers.google.com/gmail/markup/overview).
5252

53-
Mapping your app data model to Schema.org structures can be a tedious task. Using the generator, your data model will be
54-
a derived from Schema.org. Adding microdata markup to your templates or serializing your data as JSON-LD will not require
53+
Mapping your app data model to Schema.org structures can be a tedious task. Using the generator, your data model will be derived from Schema.org. Adding microdata markup to your templates or serializing your data as JSON-LD will not require
5554
specific mapping nor adaptation. It's a matter of minutes.
5655

5756
### Be ready for the future
@@ -68,4 +67,4 @@ It opens the way to generic web API clients able to extract and process data fro
6867

6968
## Credits
7069

71-
This project has been created by [Kévin Dunglas](https://dunglas.fr) and is sponsored by [Les-Tilleuls.coop](https://les-tilleuls.coop).
70+
This project was created by [Kévin Dunglas](https://dunglas.fr) and is sponsored by [Les-Tilleuls.coop](https://les-tilleuls.coop).

0 commit comments

Comments
 (0)