Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

polished docs #11

Merged
merged 1 commit into from
Apr 6, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
90 changes: 42 additions & 48 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,63 +1,57 @@
# GoSMS.cz Api Integration

Easy-to-use [GoSMS.cz](https://gosms.eu) API integration for [`Nette Framework`](https://github.com/nette/).

-----

[![Build Status](https://img.shields.io/travis/contributte/gosms.svg?style=flat-square)](https://travis-ci.org/contributte/gosms)
[![Code coverage](https://img.shields.io/coveralls/contributte/gosms.svg?style=flat-square)](https://coveralls.io/r/contributte/gosms)
[![Licence](https://img.shields.io/packagist/l/contributte/gosms.svg?style=flat-square)](https://packagist.org/packages/contributte/gosms)
[![Downloads this Month](https://img.shields.io/packagist/dm/contributte/gosms.svg?style=flat-square)](https://packagist.org/packages/contributte/gosms)
[![Downloads total](https://img.shields.io/packagist/dt/contributte/gosms.svg?style=flat-square)](https://packagist.org/packages/contributte/gosms)
[![Latest stable](https://img.shields.io/packagist/v/contributte/gosms.svg?style=flat-square)](https://packagist.org/packages/contributte/gosms)
[![PHPStan](https://img.shields.io/badge/PHPStan-enabled-brightgreen.svg?style=flat)](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)

## Install
![](https://heatbadger.now.sh/github/readme/contributte/gosms/)

<p align=center>
<a href="https://github.com/contributte/gosms/actions"><img src="https://badgen.net/github/checks/contributte/gosms/master"></a>
<a href="https://coveralls.io/r/contributte/gosms"><img src="https://badgen.net/coveralls/c/github/contributte/gosms"></a>
<a href="https://packagist.org/packages/contributte/gosms"><img src="https://badgen.net/packagist/dm/contributte/gosms"></a>
<a href="https://packagist.org/packages/contributte/gosms"><img src="https://badgen.net/packagist/v/contributte/gosms"></a>
</p>
<p align=center>
<a href="https://packagist.org/packages/contributte/gosms"><img src="https://badgen.net/packagist/php/contributte/gosms"></a>
<a href="https://github.com/contributte/gosms"><img src="https://badgen.net/github/license/contributte/gosms"></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/gosms` use [Composer](https://getcomposer.org).

```bash
composer require contributte/gosms
```

## Documentation

For details on how to use this package, check out our [documentation](.docs).

## Versions

| State | Version | Branch | PHP |
|-------------|---------|----------|----------|
| dev | `^0.4` | `master` | `>= 7.2` |
| stable | `^0.3` | `master` | `>= 7.2` |

## Overview

- [Requirements - what do do you need](https://github.com/contributte/gosms/blob/master/.docs/README.md#requirements)
- [Installation - how to register an extension](https://github.com/contributte/gosms/blob/master/.docs/README.md#Installation)
- [Usage - how to use it](https://github.com/contributte/gosms/blob/master/.docs/README.md#usage)

## Maintainers

<table>
<tbody>
<tr>
<td align="center">
<a href="https://github.com/f3l1x">
<img width="150" height="150" src="https://avatars2.githubusercontent.com/u/538058?v=3&s=150">
</a>
</br>
<a href="https://github.com/f3l1x">Milan Felix Šulc</a>
</td>
<td align="center">
<a href="https://github.com/Vody105">
<img width="150" height="150" src="https://avatars2.githubusercontent.com/u/22433893?v=3&s=150">
</a>
</br>
<a href="https://github.com/Vody105">Filip Šuška</a>
</td>
</tr>
</tbody>
</table>
## 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/f3l1x">
<img width="80" height="80" src="https://avatars2.githubusercontent.com/u/538058?v=3&s=80">
</a>

<a href="https://github.com/Vody105">
<img width="80" height="80" src="https://avatars2.githubusercontent.com/u/22433893?v=3&s=80">
</a>

-----

Thank you for testing, reporting and contributing.
Consider to [support](https://contributte.org/partners.html) **contributte** development team.
Also thank you for using this package.