Skip to content

Latest commit

 

History

History
39 lines (26 loc) · 1.24 KB

README.md

File metadata and controls

39 lines (26 loc) · 1.24 KB
Raw

gedcomx-fs-js

npm Build Status codecov

JavaScript library for FamilySearch extensions to the GEDCOM X spec. Designed to be used with gedcomx-js.

Install

First install gedcomx-js.

NPM

npm install --save gedcomx-js gedcomx-fs-js

CDN via unpkg

<script src="https://unpkg.com/[email protected]/dist/gedcomx-fs.min.js"></script>

In the browser, gedcomx-fs-js is attached to the window as a global named GedcomxFS.

Full Build

As of 1.3.1 we also publish a full build which includes gedcomx-js and thus doesn't require you to install or include it seperately and also doesn't require you to call GedcomX.addExtensions() as documented below.

Usage

// First load gedcomx-js. Then we register the FS extensions.
GedcomX.addExtensions(GedcomxFS);