Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
webeweb committed Mar 14, 2024
1 parent 27380fe commit 36d02fd
Showing 1 changed file with 15 additions and 14 deletions.
29 changes: 15 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
pappers-library
===============

[![Build Status](https://img.shields.io/github/actions/workflow/status/webeweb/pappers-library/build.yml?style=flat-square)](https://github.com/webeweb/pappers-library/actions)
[![Coverage Status](https://img.shields.io/coveralls/github/webeweb/pappers-library/master.svg?style=flat-square)](https://coveralls.io/github/webeweb/pappers-library?branch=master)
[![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/quality/g/webeweb/pappers-library/master.svg?style=flat-square)](https://scrutinizer-ci.com/g/webeweb/pappers-library/?branch=master)
[![Latest Stable Version](https://img.shields.io/packagist/v/webeweb/pappers-library.svg?style=flat-square)](https://packagist.org/packages/webeweb/pappers-library)
[![License](https://img.shields.io/packagist/l/webeweb/pappers-library.svg?style=flat-square)](https://packagist.org/packages/webeweb/pappers-library)
[![composer.lock](https://img.shields.io/badge/.lock-uncommited-important.svg?style=flat-square)](https://packagist.org/packages/webeweb/pappers-library)
[![Github actions workflow status](https://img.shields.io/github/actions/workflow/status/webeweb/pappers-library/build.yml?style=for-the-badge&color2088FF&logo=github)](https://github.com/webeweb/pappers-library/actions)
[![Coveralls](https://img.shields.io/coveralls/github/webeweb/pappers-library/master.svg?style=for-the-badge&color=3F5767&logo=coveralls)](https://coveralls.io/github/webeweb/pappers-library?branch=master)
[![Scrutinizer quality](https://img.shields.io/scrutinizer/quality/g/webeweb/pappers-library/master.svg?style=for-the-badge&color=8A9296&logo=scrutinizer)](https://scrutinizer-ci.com/g/webeweb/pappers-library/?branch=master)
[![Packagist version](https://img.shields.io/packagist/v/webeweb/pappers-library.svg?style=for-the-badge&color=F28D1A&logo=packagist)](https://packagist.org/packages/webeweb/pappers-library)

[![Packagist license](https://img.shields.io/packagist/l/webeweb/pappers-library.svg?style=for-the-badge&colorF28D1A&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHN0cm9rZT0iI0ZGRiIgdmlld0JveD0iMCAwIDI0IDI0Ij48cGF0aCBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIHN0cm9rZS13aWR0aD0iMiIgZD0ibTMgNiAzIDFtMCAwLTMgOWE1LjAwMiA1LjAwMiAwIDAgMCA2LjAwMSAwTTYgN2wzIDlNNiA3bDYtMm02IDIgMy0xbS0zIDEtMyA5YTUuMDAyIDUuMDAyIDAgMCAwIDYuMDAxIDBNMTggN2wzIDltLTMtOS02LTJtMC0ydjJtMCAxNlY1bTAgMTZIOW0zIDBoMyIvPjwvc3ZnPg==)](./LICENSE)
[![composer.lock](https://img.shields.io/badge/.lock-uncommited-important.svg?style=for-the-badge&color=885630&logo=composer)](.)

Integrate Pappers API with your projects.

Expand All @@ -15,19 +16,19 @@ Integrate Pappers API with your projects.
> will become stable at a certain point, but for now, use at your own risk.
If you like this package, pay me a beer (or a coffee)
[![paypal.me](https://img.shields.io/badge/paypal.me-webeweb-0070ba.svg?style=flat-square&logo=paypal)](https://www.paypal.me/webeweb)
[![paypal.me](https://img.shields.io/badge/paypal.me-webeweb-003087.svg?style=flat-square&logo=paypal)](https://www.paypal.me/webeweb)

## Compatibility

[![PHP](https://img.shields.io/packagist/php-v/webeweb/pappers-library.svg?style=flat-square)](http://php.net)
[![PHP](https://img.shields.io/packagist/php-v/webeweb/pappers-library.svg?style=for-the-badge&color=777BB4&logo=php)](http://php.net)

## Installation

Open a command console, enter your project directory and execute the following
command to download the latest stable version of this package:

```bash
$ composer require webeweb/pappers-library
composer require webeweb/pappers-library
```

This command requires you to have Composer installed globally, as explained in
Expand All @@ -46,15 +47,15 @@ Open a command console and execute the following commands to download the latest
stable version of this package:

```bash
$ git clone https://github.com/webeweb/pappers-library.git
$ cd pappers-library
$ composer install
git clone https://github.com/webeweb/pappers-library.git
cd pappers-library
composer install
```

Once all required libraries are installed then do:

```bash
$ vendor/bin/phpunit
vendor/bin/phpunit
```

> IMPORTANT NOTICE: To test the package with your API key, pastes it into a
Expand All @@ -71,4 +72,4 @@ Please note that the Pappers API is free for use, see their
## Donate

If you like this work, please consider donating at
[![paypal.me](https://img.shields.io/badge/paypal.me-webeweb-0070ba.svg?style=flat-square&logo=paypal)](https://www.paypal.me/webeweb)
[![paypal.me](https://img.shields.io/badge/paypal.me-webeweb-003087.svg?style=flat-square&logo=paypal)](https://www.paypal.me/webeweb)

0 comments on commit 36d02fd

Please sign in to comment.