Skip to content

Commit 022858d

Browse files
committed
Update description & add badge
1 parent f7907e5 commit 022858d

File tree

2 files changed

+11
-2
lines changed

2 files changed

+11
-2
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
[![PyPI version](https://badge.fury.io/py/fordpass.svg)](https://badge.fury.io/py/fordpass)
2+
13
# fordpass-python
24

35
This is a basic Python wrapper around the FordPass APIs. It's more or less a straight port of @d4v3y0rk's NPM module [d4v3y0rk/ffpass](https://github.com/d4v3y0rk/ffpass-module) - props to him for his work figuring out the relevant API requests needed.
@@ -11,6 +13,13 @@ This is a basic Python wrapper around the FordPass APIs. It's more or less a str
1113
* Lock the doors
1214
* Unlock the doors
1315

16+
## Install
17+
Install using pip:
18+
19+
```
20+
pip install fordpass
21+
```
22+
1423
## Demo
1524

1625
To test the libary there is a demo script `demo.py`.

setup.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@
55

66
setup(
77
name='fordpass',
8-
version='0.0.1',
8+
version='0.0.2',
99
author="Dave Clarke",
1010
author_email="info@daveclarke.me",
11-
description="Wrapper around the FordPass APIs",
11+
description="Python wrapper for the FordPass API for Ford vehicle information and control: start, stop, lock, unlock.",
1212
long_description=long_description,
1313
long_description_content_type="text/markdown",
1414
url="https://github.com/clarkd/fordpass-python",

0 commit comments

Comments
 (0)