Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
j4asper committed Sep 7, 2023
1 parent f5df06b commit f4220b0
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,9 @@ Install current code from this repo, you will need to have git installed in orde
python -m pip install git+https://github.com/j4asper/dmr.py
```

## Example
## Example

The library is very easy to use, these two examples might be the only methods you need to know.

**Synchronously**

Expand All @@ -46,22 +48,20 @@ print("The vehicle make is:", vehicle.make)

---

**Asynchronously**
**Asynchronously**

```python
from dmr import DMR

license_plate = "cw87553"

# Get DMR object with data
# Get Vehicle object with data
vehicle = await DMR.get_by_plate_async(license_plate)

print("The vehicle make is:", vehicle.make)
# The vehicle make is: Suzuki
```

**All attributes to the Vehicle object [can be viewed in the Wiki](https://github.com/j4asper/dmr.py/wiki/DMR-Attributes 'Click here to go to the Wiki')**

## Contributing:

I would be more than happy if those who know how to make pull requests, contribute with code! Sometimes XPaths may not match with the ones on the [danish vehicle register](https://motorregister.skat.dk/dmr-kerne/koeretoejdetaljer/visKoeretoej 'motorregister.skat.dk'), if that's the case, then you can either make a pull request with XPath fixes or make an issue saying that the XPaths are wrong, then I will fix it. XPaths are kept in [this file](https://github.com/j4asper/dmr.py/blob/main/dmr/utils/xpaths.py).
Expand Down

0 comments on commit f4220b0

Please sign in to comment.