Skip to content

Commit

Permalink
Update README.md: license, installation
Browse files Browse the repository at this point in the history
  • Loading branch information
slruslan authored Apr 15, 2017
1 parent 8326348 commit 19e852d
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,20 @@
# Proxy6.net PHP API wrapper

![Packagist](https://img.shields.io/packagist/dt/slruslan/php-proxy6.svg)
![License GPL](http://img.shields.io/badge/license-GPL-blue.svg)
[![Latest Version on Packagist](https://img.shields.io/packagist/v/slruslan/php-proxy6.svg?style=flat-square)](https://packagist.org/packages/slruslan/php-proxy6)
![License GPL](http://img.shields.io/badge/license-GPL-blue.svg?style=flat-square)

Простая PHP обертка для API сервиса Proxy6.net.

Написана в соответствии с [официальной документацией](https://proxy6.net/developers).

## Установка

С помощью Composer:

``` bash
$ composer require slruslan/php-proxy6
```

## Использование

Чтобы начать использование API, потребуется сгенерировать API ключ.
Expand Down Expand Up @@ -49,6 +57,10 @@ $api->prolong(30, [1, 2, 3]);

Если кто-то поможет с написанием корректной документации и доработкой самой библиотеки - в частности, обработкой ошибок, более удобным представлением ответов и т.д. - приму любые pull requests и буду очень сильно благодарен :)

## Лицензия

GNU General Public License v3.0 (GPL). Полное описание доступно в файле [LICENSE](LICENSE).

## Контакты для связи:

По всем вопросам можно писать сюда:
Expand Down

0 comments on commit 19e852d

Please sign in to comment.