Skip to content

Commit

Permalink
Adding support for bower package management
Browse files Browse the repository at this point in the history
  • Loading branch information
seanmcilvenna committed May 10, 2018
1 parent 80aa2c2 commit 62c31d7
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,10 @@ The library uses technologies that are safe for use in browser-only applications
# Installation
```
npm install fhir
or
bower install fhir
```

To use in a node.js application, require the "fhir" module.
```
var Fhir = require('fhir');
Expand All @@ -23,11 +26,8 @@ To use in a browser application, reference dist/bundle.js.

```
<script type="text/javascript" src="node_modules/fhir/dist/bundle.js"></script>
```

# Test
```
npm test
or
<script type="text/javascript" src="bower_components/fhir/dist/bundle.js"></script>
```

# Basic Usage
Expand All @@ -49,3 +49,8 @@ API documentation can be found at http://lantanagroup.github.io/FHIR.js/
# Implementation Notes
* Compatible with FHIR Release 4 Candidate v3.2.0
* FHIR profiles (within the "profiles" directory) are used to determine whether properties should be arrays, the data type and cardinality of each property, etc.. The profiles are first combined using packageProfiles.js into a single bundle of all profiles. A second pass over the profiles is performed to create a hierarchy (rather than a flat list) of the properties, and only includes information that validation is concerned about. The result of the second pass is stored in profiles/types.json and profiles/valueSets.json.

# Test
```
npm test
```
28 changes: 28 additions & 0 deletions bower.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
{
"name": "fhir-js",
"description": "Node.JS library for serializing/deserializing FHIR resources between JS/JSON and XML using various node.js XML libraries.",
"main": "dist/bundle.js",
"authors": [
"Sean McIlvenna @ Lantana Consulting Group"
],
"license": "ISC",
"keywords": [
"fhir",
"healthcare",
"interoperability",
"xml",
"json",
"serialization",
"hl7",
"standards",
"clinical"
],
"homepage": "https://github.com/lantanagroup/FHIR.js",
"ignore": [
"**/.*",
"node_modules",
"bower_components",
"test",
"tests"
]
}

0 comments on commit 62c31d7

Please sign in to comment.