Skip to content
This repository has been archived by the owner on Aug 24, 2024. It is now read-only.

Commit

Permalink
updated README to explain parameters and added database heading
Browse files Browse the repository at this point in the history
  • Loading branch information
Alex Mills committed Jun 1, 2020
1 parent 0b0e3a0 commit 9a4d3e8
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,20 @@ $parser->parse($filename, true);
```

## Documentation

### Database
This package will create the following database tables, which map to models:
* places -> `Asdfx\LaravelGedcom\Models\Place`
* persons -> `Asdfx\LaravelGedcom\Models\Person`
* person_events -> `Asdfx\LaravelGedcom\Models\PersonEvent`
* families `Asdfx\LaravelGedcom\Models\Family`
* family_events `Asdfx\LaravelGedcom\Models\FamilyEvents`

### `parse()` Method
The `parse()` method takes two parameters, `string $filename`, and `bool $progressBar = false`.
If you set `$progressBar` to true, a ProgressBar will be output to `php://stdout`, which is useful when you are calling
the parser from Artisan commands.

## Contributing

Pull requests are welcome, as are issues.

0 comments on commit 9a4d3e8

Please sign in to comment.