geneontology / wc-gocam-viz

Web component to visualize GO-CAMs
BSD 3-Clause "New" or "Revised" License
2 stars 2 forks source link

Add documentation on how to use NPM package #13

Closed pkalita-lbl closed 1 year ago

pkalita-lbl commented 1 year ago

Currently the README only provides an example showing how to use the widget when the custom elements are defined via <script> tags pointing to scripts hosted on unpkg.com. This is fine for very simple static pages, but most clients would probably expect to add @geneontology/wc-gocam-viz as a project dependency and then import something from the @geneontology/wc-gocam-viz package in the client code to define the custom components. It's not clear from the existing documentation what that something would be.