Skip to content

Commit 7a4bfbd

Browse files
committed
Update README
1 parent 1eaa2a7 commit 7a4bfbd

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,26 @@ PyARINC424 is a tool that parses an [ARINC-424](https://en.wikipedia.org/wiki/AR
2323
- Special Use Airspace, Primary and Continuation (UR)
2424
- Grid MORA (AS)
2525

26+
## Installation
27+
PyARINC424 can be installed from PyPI using `pip`:
28+
```sh
29+
pip install pyarinc424
30+
```
31+
32+
If using `uv`, `pyarinc424` can be installed as a tool and executed globally:
33+
```sh
34+
# Add as tool
35+
uv tool install pyarinc424
36+
37+
# Usage
38+
pyarinc424 my_config.ini
39+
```
40+
2641
## Config File
2742
By default, the program looks for a `config.ini` file in the application `src` directory.
2843
You can specify a different config path by passing it as an argument:
2944
```sh
30-
python main.py /path/to/my_config.ini
45+
pyarinc424 /path/to/my_config.ini
3146
```
3247

3348
The config can be set up for *either* PostgreSQL or SQLite.

0 commit comments

Comments
 (0)