Skip to content

Commit

Permalink
adding codeclimate and updating README
Browse files Browse the repository at this point in the history
  • Loading branch information
Ahmad Nassri committed Jan 15, 2015
1 parent c1018cc commit 0b29426
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 7 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.DS_Store
build
vendor
composer.lock
composer.phar
37 changes: 33 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,14 @@
# Unirest for PHP [![Build Status](https://api.travis-ci.org/Mashape/unirest-php.png)](https://travis-ci.org/Mashape/unirest-php)
# Unirest for PHP ![GitHub version][github-image] [![version][composer-image]][composer-url]

[![Build Status][travis-image]][travis-url]
[![Code Climate][codeclimate-image]][codeclimate-url]
[![Coverage Status][codecoverage-image]][codecoverage-url]
[![Dependency Status][dependency-image]][dependency-url]

Unirest is a set of lightweight HTTP libraries available in multiple languages, ideal for most applications:

## Features

* Utility methods to call `GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS`, `TRACE`, `PATCH` requests
* Supports form parameters, file uploads and custom body entities
* Supports gzip
Expand All @@ -18,8 +25,9 @@ Created with love by [Mashape](https://www.mashape.com)

---

### Install with Composer
If you're using [Composer](https://getcomposer.org/) to manage dependencies, you can add Unirest with it.
### Install with [Componser](https://getcomposer.org)

If you're using Composer to manage dependencies, you can add Unirest with it.

```javascript
{
Expand Down Expand Up @@ -62,7 +70,7 @@ $response->code; // HTTP Status code
$response->headers; // Headers
$response->body; // Parsed body
$response->raw_body; // Unparsed body
```
```dependency-image

### File Uploads

Expand Down Expand Up @@ -154,3 +162,24 @@ Unirest\Request::verifyPeer(false); // Disables SSL cert validation
```

By default is `true`.

## License

Licensed under [the MIT license](LICENSE).

[github-image]: https://badge.fury.io/gh/mashape%2Funirest-php.svg

[composer-url]: http://badge.fury.io/ph/mashape%2Funirest-php
[composer-image]: https://badge.fury.io/ph/mashape%2Funirest-php.svg

[travis-url]: https://travis-ci.org/Mashape/unirest-php
[travis-image]: https://travis-ci.org/Mashape/unirest-php.png?branch=master

[codeclimate-url]: https://codeclimate.com/github/Mashape/unirest-php
[codeclimate-image]: https://codeclimate.com/github/Mashape/unirest-php/badges/gpa.svg

[codecoverage-url]: https://codeclimate.com/github/Mashape/unirest-php
[codecoverage-image]: https://codeclimate.com/github/Mashape/unirest-php/badges/coverage.svg

[dependency-url]: https://www.versioneye.com/user/projects/54b702db050646ca5c00019d
[dependency-image]: https://www.versioneye.com/user/projects/54b702db050646ca5c00019d/badge.svg?style=flat
8 changes: 5 additions & 3 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,13 @@
"author": "Mashape <[email protected]> (https://www.mashape.com)",
"require": {
"php": ">=5.4.0",
"ext-curl": "*",
"ext-json": "*"
"ext-curl": "0.0.0.*",
"ext-json": "~1.3"
},
"require-dev": {
"phpunit/phpunit": "*"
"ext-xdebug": "~2.2",
"phpunit/phpunit": "~4.4",
"codeclimate/php-test-reporter": "0.1.*"
},
"autoload": {
"psr-0": {
Expand Down
4 changes: 4 additions & 0 deletions phpunit.xml
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<phpunit bootstrap="tests/bootstrap.php" colors="true">
<logging>
<log type="coverage-clover" target="build/logs/clover.xml"/>
</logging>

<testsuites>
<testsuite name="Unirest Test Suite">
<directory>./tests</directory>
Expand Down

0 comments on commit 0b29426

Please sign in to comment.