README.md in jabber_admin-0.2.0 vs README.md in jabber_admin-1.0.0

- old
+ new

@@ -1,11 +1,11 @@ -![jabber_admin](doc/assets/project.png) +![jabber_admin](doc/assets/project.svg) -[![Build Status](https://travis-ci.org/hausgold/jabber_admin.svg?branch=master)](https://travis-ci.org/hausgold/jabber_admin) +[![Build Status](https://travis-ci.com/hausgold/jabber_admin.svg?branch=master)](https://travis-ci.com/hausgold/jabber_admin) [![Gem Version](https://badge.fury.io/rb/jabber_admin.svg)](https://badge.fury.io/rb/jabber_admin) -[![Maintainability](https://api.codeclimate.com/v1/badges/0b3c444d8db8acaaba97/maintainability)](https://codeclimate.com/github/hausgold/jabber_admin/maintainability) -[![Test Coverage](https://api.codeclimate.com/v1/badges/0b3c444d8db8acaaba97/test_coverage)](https://codeclimate.com/github/hausgold/jabber_admin/test_coverage) +[![Maintainability](https://api.codeclimate.com/v1/badges/dd51c4668e97771baaba/maintainability)](https://codeclimate.com/repos/5cac8bcb6969c376ed007c70/maintainability) +[![Test Coverage](https://api.codeclimate.com/v1/badges/dd51c4668e97771baaba/test_coverage)](https://codeclimate.com/repos/5cac8bcb6969c376ed007c70/test_coverage) [![API docs](https://img.shields.io/badge/docs-API-blue.svg)](https://www.rubydoc.info/gems/jabber_admin) jabber_admin is a small library to easily communicate with the [ejabberd admin API](https://docs.ejabberd.im/developer/ejabberd-api/admin-api). @@ -32,11 +32,11 @@ ``` Or install it yourself as: ```bash -$ gem inst.object_idall jabber_admin +$ gem install jabber_admin ``` ## Configuration You can configure the jabber_admin gem in a global initializer way with the @@ -85,10 +85,10 @@ JabberAdmin.register(user: 'peter@example.com', password: '123') ``` Have a close look at the method names. We support bang and non-bang variants. The bang variants perform in-deep response validation and raise children of -+JabberAdmin::Error+ in case of detected issues. These issues can be +`JabberAdmin::Error` in case of detected issues. These issues can be unpermitted API requests, or invalid payload values, etc. The predefined commands also perform response body checks when it is appropriate. (Eg. many commands respond a single zero as a success indicator) The non-bang variants will just fire the request and do not perform any checks