Skip to content

Commit

Permalink
Merge pull request #6 from ptariche/update_readme
Browse files Browse the repository at this point in the history
updated readme
  • Loading branch information
ptariche authored Oct 16, 2018
2 parents af0cc65 + b823230 commit 8b36de1
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,22 @@ Family Tree Generator -- Converts a Google Spreadsheet to a PNG Graph
- Download a copy of the file

### How to Run
- npm install
- CSV_FILE=<FILE_PATH_OF_CSV> PNG_OUTPUT=<FILE_PATH_OF_PNG_OUTPUT> npm start

### Example
- [CSV File](./examples/example_family.csv)

![Family Tree](./examples/example_family.png)


### Dependencies
- csvtojson
- json2yaml
- kingraph
- [csvtojson](https://www.npmjs.com/package/csvtojson)
- [json2yaml](https://www.npmjs.com/package/json2yaml)
- [kingraph](https://github.com/rstacruz/kingraph)

### Author
- Peter A. Tariche

### License
- MIT

### Example
- [CSV File](./examples/example_family.csv)
- ![Family Tree](./examples/example_family.png)

0 comments on commit 8b36de1

Please sign in to comment.