Skip to content

Commit

Permalink
Added usage section to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Nicklas Reincke committed Jan 9, 2018
1 parent 481208b commit 8908dff
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,20 @@ The module can be installed via [pip](https://pip.pypa.io/).
Run `pip install python-gedcom` to install or `pip install python-gedcom --upgrade`
to upgrade to the newest version uploaded to the [PyPI repository](https://pypi.python.org/pypi/python-gedcom).

## Usage

When successfully installed you may import the `gedcom` module and use
it like so:

```python
from gedcom import *

file_path = '' # Path to your `.ged` file
gedcom = Gedcom(file_path)

# Then run methods on `gedcom` ... :)
```

## History

This module was originally based on a GEDCOM parser written by
Expand Down

0 comments on commit 8908dff

Please sign in to comment.