Skip to content

Commit

Permalink
Merge pull request #17 from Nyholm/patch-1
Browse files Browse the repository at this point in the history
Wrong link syntax
  • Loading branch information
sagikazarmark committed Oct 29, 2015
2 parents a292396 + d8b1bb0 commit eac7fa0
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 12 deletions.
10 changes: 5 additions & 5 deletions docs/httplug.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@ Httplug is an abstraction for HTTP clients. There are two main use cases:

In both cases, the client provides a `sendRequest` method to send a PSR-7 `RequestInterface` and returns a PSR-7 `ResponseInterface` or throws an exception that implements `Http\Client\Exception`.

See the (tutorial)[tutorial.md] for a concrete example.
See the [tutorial](tutorial.md) for a concrete example.


## Httplug implementations

Httplug implementations typically are either HTTP clients of their own, or they are adapters wrapping existing clients like Guzzle 6. In the latter case, they will depend on the required client implementation, so you only need to require the adapter and not the actual client.

See (packagist)[https://packagist.org/providers/php-http/client-implementation] for the full list of implementations.
See [packagist](https://packagist.org/providers/php-http/client-implementation) for the full list of implementations.

Note: Until Httplug 1.0 becomes stable, we will focus on the Guzzle6 adapter.

Expand Down Expand Up @@ -46,8 +46,8 @@ You need to edit the `composer.json` of your package to add the virtual package.
...
```

For extra convenience, you can use the (Discovery)[discovery.md] system to free the user of your package from having to instantiate the client. You should however always accept injecting the client instance to allow the user to configure the client as needed.
For extra convenience, you can use the [Discovery](discovery.md) system to free the user of your package from having to instantiate the client. You should however always accept injecting the client instance to allow the user to configure the client as needed.

Users of your package will have to select a concrete adapter in their project to make your package installable. Best point them to the (virtual package)[virtual-package.md] howto page.
Users of your package will have to select a concrete adapter in their project to make your package installable. Best point them to the [virtual package](virtual-package.md) howto page.

To be able to send requests, you should not depend on a specific PSR-7 implementation, but use the (message factory)[message-factory.md] system.
To be able to send requests, you should not depend on a specific PSR-7 implementation, but use the [message factory](message-factory.md) system.
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ PHP-HTTP is separated into several packages:
- [Discovery](discovery.md) to automatically locate a suitable Httplug implementation and PSR-7 message and URI factories.
- [Utilities](utils.md) convenience tools to simplify working with Httplug in your applications.

See (package overview)[package-overview.md] for a complete list.
See [package overview](package-overview.md) for a complete list.


## History
Expand All @@ -32,4 +32,4 @@ This project has been started by [Eric Geloen](https://github.com/egeloen) as [I

In 2015, a decision has been made to move the library to it's own organization, so PHP HTTP was born.

See (migrating)[migrating.md] for a guide how to migrate your code from the Ivory adapter to Httplug.
See [migrating](migrating.md) for a guide how to migrate your code from the Ivory adapter to Httplug.
2 changes: 1 addition & 1 deletion docs/migrating.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ If you currently use a concrete HTTP client implementation or the Ivory Http Ada

## Migrating from Ivory Http Adapter

The monolithic ivory package has been separated into several smaller, more specific packages. For a list of the packages, see the (package overview)[package-overview.md]
The monolithic ivory package has been separated into several smaller, more specific packages. For a list of the packages, see the [package overview](package-overview.md).

Instead of `Ivory\HttpAdapter\PsrHttpAdapter`, use `Http\Client\HttpClient`. The HttpClient simply has a method to send requests.

Expand Down
6 changes: 3 additions & 3 deletions docs/package-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ All packages are installed via [Composer](http://getcomposer.org/).

- Namespace: `Http\Client`
- Repository: https://github.com/php-http/httplug
- Documentation: (Httplug)[httplug.md]
- Documentation: [Httplug](httplug.md)


## message-factory
Expand All @@ -36,7 +36,7 @@ The clients are either full HTTP clients or adapters to wrap the Httplug Client

- Namespace: `Http\Discovery`
- Repository: https://github.com/php-http/discovery
- Documentation: (Discovery)[discovery.md]
- Documentation: [Discovery](discovery.md)


## utils
Expand All @@ -45,4 +45,4 @@ The clients are either full HTTP clients or adapters to wrap the Httplug Client

- Namespace: `Http\Utils`
- Repository: https://github.com/php-http/utils
- Documentation: (Utils)[utils.md]
- Documentation: [Utils](utils.md)
2 changes: 1 addition & 1 deletion docs/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This tutorial should give you an idea how to use Httplug in your project. Httplu

This tutorial will start with the first use case and then explain the special considerations to take into account when building a reusable package.

We use (composer)[https://getcomposer.org] for dependency management. Install it if you don't have it yet.
We use [composer](https://getcomposer.org) for dependency management. Install it if you don't have it yet.

## Setting up the project

Expand Down

0 comments on commit eac7fa0

Please sign in to comment.