Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
lcobucci committed May 6, 2018
1 parent f1fc9ad commit 61e659c
Showing 1 changed file with 21 additions and 21 deletions.
42 changes: 21 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Chimera - mapping

[![Total Downloads](https://img.shields.io/packagist/dt/lcobucci/chimera-mapping.svg?style=flat-square)](https://packagist.org/packages/lcobucci/chimera-mapping)
[![Latest Stable Version](https://img.shields.io/packagist/v/lcobucci/chimera-mapping.svg?style=flat-square)](https://packagist.org/packages/lcobucci/chimera-mapping)
[![Unstable Version](https://img.shields.io/packagist/vpre/lcobucci/chimera-mapping.svg?style=flat-square)](https://packagist.org/packages/lcobucci/chimera-mapping)
[![Total Downloads](https://img.shields.io/packagist/dt/chimera/mapping.svg?style=flat-square)](https://packagist.org/packages/chimera/mapping)
[![Latest Stable Version](https://img.shields.io/packagist/v/chimera/mapping.svg?style=flat-square)](https://packagist.org/packages/chimera/mapping)
[![Unstable Version](https://img.shields.io/packagist/vpre/chimera/mapping.svg?style=flat-square)](https://packagist.org/packages/chimera/mapping)

![Branch master](https://img.shields.io/badge/branch-master-brightgreen.svg?style=flat-square)
[![Build Status](https://img.shields.io/travis/lcobucci/chimera-mapping/master.svg?style=flat-square)](http://travis-ci.org/#!/lcobucci/chimera-mapping)
[![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/lcobucci/chimera-mapping/master.svg?style=flat-square)](https://scrutinizer-ci.com/g/lcobucci/chimera-mapping/?branch=master)
[![Code Coverage](https://img.shields.io/scrutinizer/coverage/g/lcobucci/chimera-mapping/master.svg?style=flat-square)](https://scrutinizer-ci.com/g/lcobucci/chimera-mapping/?branch=master)
[![Build Status](https://img.shields.io/travis/chimeraphp/mapping/master.svg?style=flat-square)](http://travis-ci.org/#!/chimeraphp/mapping)
[![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/chimeraphp/mapping/master.svg?style=flat-square)](https://scrutinizer-ci.com/g/chimeraphp/mapping/?branch=master)
[![Code Coverage](https://img.shields.io/scrutinizer/coverage/g/chimeraphp/mapping/master.svg?style=flat-square)](https://scrutinizer-ci.com/g/chimeraphp/mapping/?branch=master)

> The term Chimera (_/kɪˈmɪərə/_ or _/kaɪˈmɪərə/_) has come to describe any
mythical or fictional animal with parts taken from various animals, or to
Expand All @@ -28,15 +28,15 @@ This package provides a set of annotations to be used to configured your
command/query handlers, HTTP middleware, and command/query bus middleware.

**Important:** these annotations will only be used when used together with
packages that read them, like [`lcobucci/chimera-di-symfony`](https://github.com/lcobucci/chimera-di-symfony).
packages that read them, like [`chimera/di-symfony`](https://github.com/chimeraphp/di-symfony).

## Installation

Package is available on [Packagist](http://packagist.org/packages/lcobucci/chimera-mapping),
Package is available on [Packagist](http://packagist.org/packages/chimera/mapping),
you can install it using [Composer](http://getcomposer.org).

```shell
composer require lcobucci/chimera-mapping
composer require chimera/mapping
```

### PHP Configuration
Expand All @@ -58,29 +58,29 @@ Check the documentation for more information: https://secure.php.net/manual/en/f
These are the annotations related to how services should be mapped to the
command/query bus:

* `Lcobucci\Chimera\Mapping\ServiceBus\CommandHandler`: exposes the class as
* `Chimera\Mapping\ServiceBus\CommandHandler`: exposes the class as
a command handler
* `Lcobucci\Chimera\Mapping\ServiceBus\QueryHandler`: exposes the class as
* `Chimera\Mapping\ServiceBus\QueryHandler`: exposes the class as
a query handler
* `Lcobucci\Chimera\Mapping\ServiceBus\Middleware`: exposes the class as
* `Chimera\Mapping\ServiceBus\Middleware`: exposes the class as
a command/query middleware

And these are the ones related to how services should be mapped to the
PSR-15 application:

* `Lcobucci\Chimera\Mapping\Routing\CreateAndFetchEndpoint`: adds an endpoint
* `Chimera\Mapping\Routing\CreateAndFetchEndpoint`: adds an endpoint
that will execute a command to create a resource and then a query to fetch
its state
* `Lcobucci\Chimera\Mapping\Routing\CreatexEndpoint`: adds an endpoint
* `Chimera\Mapping\Routing\CreatexEndpoint`: adds an endpoint
that will execute a command to create a resource
* `Lcobucci\Chimera\Mapping\Routing\ExecuteAndFetchEndpoint`: adds an endpoint
* `Chimera\Mapping\Routing\ExecuteAndFetchEndpoint`: adds an endpoint
that will execute a command to modify a resource and then a query to fetch
its state
* `Lcobucci\Chimera\Mapping\Routing\ExecuteEndpoint`: adds an endpoint
* `Chimera\Mapping\Routing\ExecuteEndpoint`: adds an endpoint
that will execute a command to modify/remove a resource
* `Lcobucci\Chimera\Mapping\Routing\FetchEndpoint`: adds an endpoint
* `Chimera\Mapping\Routing\FetchEndpoint`: adds an endpoint
that will execute a query
* `Lcobucci\Chimera\Mapping\Routing\Middleware`: exposes the class as
* `Chimera\Mapping\Routing\Middleware`: exposes the class as
a PSR-15 HTTP middleware

The idea of the annotations is to simplify the mapping of services, removing
Expand All @@ -91,9 +91,9 @@ be used like this:
<?php
declare(strict_types=1);

namespace Lcobucci\MyApi\Creation;
namespace MyApi\Creation;

use Lcobucci\Chimera\Mapping as Chimera;
use Chimera\Mapping as Chimera;

/**
* @Chimera\Routing\CreateEndpoint(path="/books", command=AddToCollection::class, name="book.create", redirectTo="book.fetch_one")
Expand All @@ -107,4 +107,4 @@ final class AddToCollectionHandler

## License

MIT, see [LICENSE file](https://github.com/lcobucci/chimera-mapping/blob/master/LICENSE).
MIT, see [LICENSE file](https://github.com/chimeraphp/mapping/blob/master/LICENSE).

0 comments on commit 61e659c

Please sign in to comment.