Skip to content

Commit b5f8215

Browse files
committed
update README
1 parent 7b29d9d commit b5f8215

File tree

2 files changed

+17
-3
lines changed

2 files changed

+17
-3
lines changed

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
2+
[![PyPI version](https://badge.fury.io/py/python-redsys.svg)](https://badge.fury.io/py/python-redsys)
3+
14
# Welcome to python-redsys!
25

36
A simple, clean and less dependant client to handle payments through the
@@ -16,11 +19,19 @@ response parameters. That's what less dependant means.
1619

1720
## Example using _redirect connection_
1821

22+
### 0. Install python-redsys
23+
24+
You can add python-redsys to your project with pip:
25+
> pip install python-redsys
26+
27+
Or with poetry:
28+
> poetry add python-redsys
29+
1930
### 1. Instantiate the redirect client
2031

21-
```{.sourceCode .python}
32+
```python
2233
from decimal import Decimal as D, ROUND_HALF_UP
23-
from redsys import currencies, languages, parameters, transactions
34+
from redsys import transactions
2435
from redsys.client import RedirectClient
2536

2637
secret_key = "123456789abcdef"
@@ -30,7 +41,7 @@ client = RedirectClient(secret_key, sandbox)
3041

3142
### 2. Create a request
3243

33-
```{.sourceCode .python}
44+
```python
3445
request = client.create_request()
3546
```
3647

pyproject.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ classifiers = [
1111
'License :: OSI Approved :: MIT License',
1212
'Operating System :: OS Independent',
1313
]
14+
packages = [
15+
{ include = "redsys" }
16+
]
1417

1518
[tool.poetry.dependencies]
1619
python = "^3.9"

0 commit comments

Comments
 (0)