Polished readme (#14)

contributte · Apr 6, 2021 · d7e1726 · d7e1726
1 parent c881414
commit d7e1726
Show file tree

Hide file tree

Showing 2 changed files with 56 additions and 48 deletions.
diff --git a/.docs/README.md b/.docs/README.md
@@ -1,4 +1,4 @@
-# Contributte Elasticsearch
+# Contributte / Elasticsearch
 
 Find out more about [elasticsearch-php](https://github.com/elastic/elasticsearch-php) and also about [Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/client/php-api/5.0/index.html)
 
@@ -17,30 +17,30 @@ composer require contributte/elasticsearch
 
 Register extension.
 
-```yaml
+```neon
 extensions:
-    elasticsearch: Contributte\Elasticsearch\DI\ElasticsearchExtension
+	elasticsearch: Contributte\Elasticsearch\DI\ElasticsearchExtension
 ```
 
 ## Configuration
 
-```yaml
+```neon
 elasticsearch:
-    hosts:
-      - 'localhost'
+	hosts:
+		- 'localhost'
 ```
 
 ### Advanced configuration
 
-```yaml
+```neon
 elasticsearch:
-    hosts:
-        -
-            host: 'localhost'
-            port: 9200
-            scheme: 'https'
-            user: 'foo'
-            pass: 'bar'
+	hosts:
+		-
+			host: 'localhost'
+			port: 9200
+			scheme: 'https'
+			user: 'foo'
+			pass: 'bar'
 ```
 
 **NOTE:** The `host` is required, others are recommended, but not necessary.
diff --git a/README.md b/README.md
@@ -1,23 +1,34 @@
-# Contributte Elasticsearch
-
-Tiny integration of [elasticsearch-php](https://github.com/elastic/elasticsearch-php) into [Nette framework](https://nette.org).
-
-[![Build Status](https://img.shields.io/travis/contributte/elasticsearch.svg?style=flat-square)](https://travis-ci.org/contributte/elasticsearch)
-[![Code coverage](https://img.shields.io/coveralls/contributte/elasticsearch.svg?style=flat-square)](https://coveralls.io/r/contributte/elasticsearch)
-[![Licence](https://img.shields.io/packagist/l/contributte/elasticsearch.svg?style=flat-square)](https://packagist.org/packages/contributte/elasticsearch)
-[![Downloads this Month](https://img.shields.io/packagist/dm/contributte/elasticsearch.svg?style=flat-square)](https://packagist.org/packages/contributte/elasticsearch)
-[![Downloads total](https://img.shields.io/packagist/dt/contributte/elasticsearch.svg?style=flat-square)](https://packagist.org/packages/contributte/elasticsearch)
-[![Latest stable](https://img.shields.io/packagist/v/contributte/elasticsearch.svg?style=flat-square)](https://packagist.org/packages/contributte/elasticsearch)
-[![PHPStan](https://img.shields.io/badge/PHPStan-enabled-brightgreen.svg?style=flat-square)](https://github.com/phpstan/phpstan)
-
-## Discussion / Help
-
-[![Join the chat](https://img.shields.io/gitter/room/contributte/contributte.svg?style=flat-square)](http://bit.ly/ctteg)
+![](https://heatbadger.now.sh/github/readme/contributte/elasticsearch/)
+
+<p align=center>
+  <a href="https://github.com/contributte/elasticsearch/actions"><img src="https://badgen.net/github/checks/contributte/elasticsearch/master"></a>
+  <a href="https://coveralls.io/r/contributte/elasticsearch"><img src="https://badgen.net/coveralls/c/github/contributte/elasticsearch"></a>
+  <a href="https://packagist.org/packages/contributte/elasticsearch"><img src="https://badgen.net/packagist/dm/contributte/elasticsearch"></a>
+  <a href="https://packagist.org/packages/contributte/elasticsearch"><img src="https://badgen.net/packagist/v/contributte/elasticsearch"></a>
+</p>
+<p align=center>
+  <a href="https://packagist.org/packages/contributte/elasticsearch"><img src="https://badgen.net/packagist/php/contributte/elasticsearch"></a>
+  <a href="https://github.com/contributte/elasticsearch"><img src="https://badgen.net/github/license/contributte/elasticsearch"></a>
+  <a href="https://bit.ly/ctteg"><img src="https://badgen.net/badge/support/gitter/cyan"></a>
+  <a href="https://bit.ly/cttfo"><img src="https://badgen.net/badge/support/forum/yellow"></a>
+  <a href="https://contributte.org/partners.html"><img src="https://badgen.net/badge/sponsor/donations/F96854"></a>
+</p>
+
+<p align=center>
+Website 🚀 <a href="https://contributte.org">contributte.org</a> | Contact 👨🏻‍💻 <a href="https://f3l1x.io">f3l1x.io</a> | Twitter 🐦 <a href="https://twitter.com/contributte">@contributte</a>
+</p>
+
+## Usage
+
+To install the latest version of `contributte/elasticsearch` use [Composer](https://getcomposer.org).
+
+```bash
+composer require contributte/elasticsearch
+```
 
 ## Documentation
 
-- [Setup](.docs/README.md#setup)
-- [Configuration](.docs/README.md#configuration)
+For details on how to use this package, check out our [documentation](.docs).
 
 ## Versions
 
@@ -27,20 +38,17 @@ Tiny integration of [elasticsearch-php](https://github.com/elastic/elasticsearch
 | stable      | `^0.3`  | `master` | 3.0+  | `^7.2`  |
 | stable      | `^0.1`  | `master` | 2.4   | `>=7.1` |
 
-## Maintainers
-
-<table>
-  <tbody>
-    <tr>
-      <td align="center">
-        <a href="https://github.com/vojtamares">
-            <img width="150" height="150" src="https://avatars2.githubusercontent.com/u/7180610?v=3&s=150">
-        </a>
-        </br>
-        <a href="https://github.com/vojtamares">Vojta Mareš</a>
-      </td>
-    </tr>
-  </tbody>
-</table>
-
-Thank you for testing, reporting and contributing.
+## Development
+
+See [how to contribute](https://contributte.org/contributing.html) to this package.
+
+This package is currently maintaining by these authors.
+
+<a href="https://github.com/vojtamares">
+  <img width="80" height="80" src="https://avatars2.githubusercontent.com/u/7180610?v=3&s=80">
+</a>
+
+-----
+
+Consider to [support](https://contributte.org/partners.html) **contributte** development team.
+Also thank you for using this package.