Merge pull request #4 from vstelmakh/improve-readme

Improve readme and git attributes

.gitattributes

@@ -0,0 +1,10 @@
+.gitattributes export-ignore
+.gitignore export-ignore
+
+/.github export-ignore
+/resources export-ignore
+/tests export-ignore
+
+phpcs.xml export-ignore
+phpstan.neon export-ignore
+phpunit.xml export-ignore

README.md

@@ -1,25 +1,28 @@
-# Url highlight
-![Build status](https://github.com/vstelmakh/url-highlight/workflows/build/badge.svg?branch=master)
-![PHP version](https://img.shields.io/packagist/php-v/vstelmakh/url-highlight)
-![License](https://img.shields.io/github/license/vstelmakh/url-highlight)
+![Url highlight](./resources/url-highlight-logo.svg)
+---
+[![Build status](https://github.com/vstelmakh/url-highlight/workflows/build/badge.svg?branch=master)](https://github.com/vstelmakh/url-highlight/actions)
+[![PHP version](https://img.shields.io/packagist/php-v/vstelmakh/url-highlight)](https://www.php.net/)
+[![License](https://img.shields.io/github/license/vstelmakh/url-highlight)](LICENSE)
 
-PHP library to parse urls from string input. Current features:
+**Url highlight** - PHP library to parse urls from string input. Current features:
 - Check if string is url
 - Parse urls from string
 - Replace urls in string by html tags
 
 ## Installation
-There are [Twig extension](https://github.com/vstelmakh/url-highlight-twig-extension) and [Symfony bundle](https://github.com/vstelmakh/url-highlight-symfony-bundle) available.  
-
-Install the latest version with:  
+Install the latest version with [composer](https://getcomposer.org/):  
 ```bash
-$ composer require vstelmakh/url-highlight
+composer require vstelmakh/url-highlight
 ```
+Also, there are
+ [![Twig](./resources/twig-logo.png) Twig extension](https://github.com/vstelmakh/url-highlight-twig-extension)
+ and [![Symfony](./resources/symfony-logo.png) Symfony bundle](https://github.com/vstelmakh/url-highlight-symfony-bundle) available.  
 
 ## Setup
 Just instantiate class object:  
 ```php
 <?php
+require __DIR__ . '/vendor/autoload.php';
 
 use VStelmakh\UrlHighlight\UrlHighlight;