README: clear spaces, add tests and coverage badges

Author: TomasVotruba

README.md

@@ -1,5 +1,8 @@
-TypeResolver and FqsenResolver
-==============================
+# TypeResolver and FqsenResolver
+
+[![Build Status](https://img.shields.io/travis/phpDocumentor/TypeResolver/master.svg?style=flat-square)](https://travis-ci.org/phpDocumentor/TypeResolver)
+
+[![Code Coverage](https://img.shields.io/coveralls/phpDocumentor/TypeResolver/master.svg?style=flat-square)](https://coveralls.io/github/phpDocumentor/TypeResolver)
 
 The specification on types in DocBlocks (PSR-5) describes various keywords and special constructs
 but also how to statically resolve the partial name of a Class into a Fully Qualified Class Name (FQCN).
@@ -22,8 +25,7 @@ The easiest way to install this library is with [Composer](https://getcomposer.o
 
 ## Examples
 
-Ready to dive in and don't want to read through all that text below? Just consult the [examples](examples) folder and
-check which type of action that your want to accomplish.
+Ready to dive in and don't want to read through all that text below? Just consult the [examples](examples) folder and check which type of action that your want to accomplish.
 
 ## On Types and Element Names
 
@@ -59,8 +61,7 @@ Where the FqsenResolver can resolve:
 
 ## Resolving a type
 
-In order to resolve a type you will have to instantiate the class `\phpDocumentor\Reflection\TypeResolver`
-and call its `resolve` method like this:
+In order to resolve a type you will have to instantiate the class `\phpDocumentor\Reflection\TypeResolver` and call its `resolve` method like this:
 
 ```php
 $typeResolver = new \phpDocumentor\Reflection\TypeResolver();
@@ -71,31 +72,24 @@ In this example you will receive a Value Object of class `\phpDocumentor\Reflect
 elements, one of type `\phpDocumentor\Reflection\Types\String_` and one of type 
 `\phpDocumentor\Reflection\Types\Integer`.
 
-The real power of this resolver is in its capability to expand partial class names into fully qualified class names; but
-in order to do that we need an additional `\phpDocumentor\Reflection\Types\Context` class that will inform the resolver 
-in which namespace the given expression occurs and which namespace aliases (or imports) apply.
+The real power of this resolver is in its capability to expand partial class names into fully qualified class names; but in order to do that we need an additional `\phpDocumentor\Reflection\Types\Context` class that will inform the resolver in which namespace the given expression occurs and which namespace aliases (or imports) apply.
 
 ## Resolving an FQSEN
 
-A Fully Qualified Structural Element Name is a reference to another element in your code bases and can be resolved using
-the `\phpDocumentor\Reflection\FqsenResolver` class' `resolve` method, like this:
+A Fully Qualified Structural Element Name is a reference to another element in your code bases and can be resolved using the `\phpDocumentor\Reflection\FqsenResolver` class' `resolve` method, like this:
 
 ```php
 $fqsenResolver = new \phpDocumentor\Reflection\FqsenResolver();
 $fqsen = $fqsenResolver->resolve('\phpDocumentor\Reflection\FqsenResolver::resolve()');
 ```
 
-In this example we resolve a Fully Qualified Structural Element Name (meaning that it includes the full namespace, class
-name and element name) and receive a Value Object of type `\phpDocumentor\Reflection\Fqsen`.
+In this example we resolve a Fully Qualified Structural Element Name (meaning that it includes the full namespace, class name and element name) and receive a Value Object of type `\phpDocumentor\Reflection\Fqsen`.
 
-The real power of this resolver is in its capability to expand partial element names into Fully Qualified Structural 
-Element Names; but in order to do that we need an additional `\phpDocumentor\Reflection\Types\Context` class that will 
-inform the resolver in which namespace the given expression occurs and which namespace aliases (or imports) apply.
+The real power of this resolver is in its capability to expand partial element names into Fully Qualified Structural Element Names; but in order to do that we need an additional `\phpDocumentor\Reflection\Types\Context` class that will inform the resolver in which namespace the given expression occurs and which namespace aliases (or imports) apply.
 
 ## Resolving partial Classes and Structural Element Names
 
-Perhaps the best feature of this library is that it knows how to resolve partial class names into fully qualified class 
-names.
+Perhaps the best feature of this library is that it knows how to resolve partial class names into fully qualified class names.
 
 For example, you have this file:
 
@@ -117,9 +111,8 @@ class Classy
 ```
 
 Suppose that you would want to resolve (and expand) the type in the `@var` tag and the element name in the `@see` tag.
-For the resolvers to know how to expand partial names you have to provide a bit of _Context_ for them by instantiating
-a new class named `\phpDocumentor\Reflection\Types\Context` with the name of the namespace and the aliases that are in 
-play.
+
+For the resolvers to know how to expand partial names you have to provide a bit of _Context_ for them by instantiating a new class named `\phpDocumentor\Reflection\Types\Context` with the name of the namespace and the aliases that are in play.
 
 ### Creating a Context
 
@@ -132,9 +125,7 @@ $context = new \phpDocumentor\Reflection\Types\Context(
 );
 ```
 
-Or by using the `\phpDocumentor\Reflection\Types\ContextFactory` to instantiate a new context based on a Reflector 
-object or by providing the namespace that you'd like to extract and the source code of the file in which the given
-type expression occurs.
+Or by using the `\phpDocumentor\Reflection\Types\ContextFactory` to instantiate a new context based on a Reflector object or by providing the namespace that you'd like to extract and the source code of the file in which the given type expression occurs.
 
 ```php
 $contextFactory = new \phpDocumentor\Reflection\Types\ContextFactory();
@@ -150,8 +141,7 @@ $context = $contextFactory->createForNamespace('\My\Example', file_get_contents(
 
 ### Using the Context
 
-After you have obtained a Context it is just a matter of passing it along with the `resolve` method of either Resolver 
-class as second argument and the Resolvers will take this into account when resolving partial names.
+After you have obtained a Context it is just a matter of passing it along with the `resolve` method of either Resolver class as second argument and the Resolvers will take this into account when resolving partial names.
 
 To obtain the resolved class name for the `@var` tag in the example above you can do:
 
@@ -160,24 +150,17 @@ $typeResolver = new \phpDocumentor\Reflection\TypeResolver();
 $type = $typeResolver->resolve('Types\Context', $context);
 ```
 
-When you do this you will receive an object of class `\phpDocumentor\Reflection\Types\Object_` for which you can call 
-the `getFqsen` method to receive a Value Object that represents the complete FQSEN. So that would be 
-`phpDocumentor\Reflection\Types\Context`.
+When you do this you will receive an object of class `\phpDocumentor\Reflection\Types\Object_` for which you can call the `getFqsen` method to receive a Value Object that represents the complete FQSEN. So that would be `phpDocumentor\Reflection\Types\Context`.
 
 > Why is the FQSEN wrapped in another object `Object_`?
 > 
-> The resolve method of the TypeResolver only returns object with the interface `Type` and the FQSEN is a common
-> type that does not represent a Type. Also: in some cases a type can represent an "Untyped Object", meaning that it
-> is an object (signified by the `object` keyword) but does not refer to a specific element using an FQSEN.
+> The resolve method of the TypeResolver only returns object with the interface `Type` and the FQSEN is a common type that does not represent a Type. Also: in some cases a type can represent an "Untyped Object", meaning that it is an object (signified by the `object` keyword) but does not refer to a specific element using an FQSEN.
 
-Another example is on how to resolve the FQSEN of a method as can be seen with the `@see` tag in the example above. To
-resolve that you can do the following:
+Another example is on how to resolve the FQSEN of a method as can be seen with the `@see` tag in the example above. To resolve that you can do the following:
 
 ```php
 $fqsenResolver = new \phpDocumentor\Reflection\FqsenResolver();
 $type = $fqsenResolver->resolve('Classy::otherFunction()', $context);
 ```
 
-Because Classy is a Class in the current namespace its FQSEN will have the `My\Example` namespace and by calling the 
-`resolve` method of the FQSEN Resolver you will receive an `Fqsen` object that refers to 
-`\My\Example\Classy::otherFunction()`.
+Because Classy is a Class in the current namespace its FQSEN will have the `My\Example` namespace and by calling the `resolve` method of the FQSEN Resolver you will receive an `Fqsen` object that refers to `\My\Example\Classy::otherFunction()`.