From 8908dffd8f897782ae6b5f0d10935e90579bde67 Mon Sep 17 00:00:00 2001 From: Nicklas Reincke Date: Tue, 9 Jan 2018 16:38:37 +0100 Subject: [PATCH] Added usage section to documentation --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 35c9863..5aceeba 100644 --- a/README.md +++ b/README.md @@ -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