Skip to content

Commit

Permalink
README: Better formating + install info + license
Browse files Browse the repository at this point in the history
  • Loading branch information
janbarasek authored Aug 6, 2020
1 parent eea79f9 commit 5e391a4
Showing 1 changed file with 20 additions and 7 deletions.
27 changes: 20 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,24 @@ CSOB Transaction authorizator

Find transactions in mail box, parse and call authorization logic.

Install
-------
📦 Installation & Basic Usage
-----------------------------

By Composer:
This package can be installed using [Package Manager](https://github.com/baraja-core/package-manager) which is also part of the Baraja [Sandbox](https://github.com/baraja-core/sandbox). If you are not using it, you have to install the package manually following this guide.

A model configuration can be found in the `common.neon` file inside the root of the package.

To manually install the package call Composer and execute the following command:

```shell
composer require baraja-core/csob-payment-authorizator
$ composer require baraja-core/csob-payment-authorizator
```

And create service by Neon:
In the projects `common.neon` you have to define the database credentials. A fully working example of configuration can be found in the `common.neon` file inside this package.

You can define the configuration simply using parameters (stored in the super-global array `parameters`).

For example:

```yaml
services:
Expand All @@ -27,8 +35,8 @@ parameters:
password: xxx
```
Usage
-----
⚙️ Usage
--------
In presenter use it very simply:
Expand All @@ -51,3 +59,8 @@ $csob->authOrders(
}
);
```

📄 License
-----------

`baraja-core/csob-payment-authorizator` is licensed under the MIT license. See the [LICENSE](https://github.com/baraja-core/doctrine/blob/master/LICENSE) file for more details.

0 comments on commit 5e391a4

Please sign in to comment.