Skip to content

Commit

Permalink
Adds link to our NPM package and a badge from shields.io.
Browse files Browse the repository at this point in the history
  • Loading branch information
gaurav committed Jul 3, 2024
1 parent abed61c commit 1993091
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

[![Build Status](https://github.com/phyloref/phyx.js/workflows/Build%20and%20Test/badge.svg)](https://github.com/phyloref/phyx.js/actions?query=workflow%3A%22Build+and+Test%22)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5576556.svg)](https://doi.org/10.5281/zenodo.5576556)
[![NPM Version](https://img.shields.io/npm/v/@phyloref/phyx)](https://www.npmjs.com/package/@phyloref/phyx)

The Phyloreference Exchange (PHYX) format is a JSON representation that can be
used to store and transfer definitions of [phyloreferences]. This library provides
Expand All @@ -10,6 +11,14 @@ entire Phyx file into a [JSON-LD] representation that can be reasoned over with
an [OWL 2 DL] reasoner. See the [Phyloreference Curation Tool] or the [Clade Ontology]
for examples of its usage.

## Usage

You can install [phyx.js using npm](https://www.npmjs.com/package/@phyloref/phyx):

```shell
$ npm install @phyloref/phyx
```

[Tutorials demonstrating the use of phyx.js](./tutorials/) are available.

## Citation
Expand Down

0 comments on commit 1993091

Please sign in to comment.