Skip to content

Commit

Permalink
configure publishing to npmjs (#25)
Browse files Browse the repository at this point in the history
* add pkg.repository

* pkg.name=fhir-kit-client

* pkg.files, to publish to npmjs

* gitignore .npmrc

* add keywords

* Tweaks to README

* Re-word features section

* Update author and keywords
  • Loading branch information
foxtree authored and bkaney committed Apr 11, 2018
1 parent c302fab commit 47686ee
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 11 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Expand Up @@ -39,6 +39,9 @@ jspm_packages/
# Typescript v1 declaration files
typings/

# npm config used for publishing
.npmrc

# Optional npm cache directory
.npm

Expand Down
27 changes: 18 additions & 9 deletions README.md
Expand Up @@ -6,17 +6,22 @@ Node FHIR client library
# Features

* Support for STU3 (3.0.1, 1.8.0, 1.6.0, 1.4.0, 1.1.0) and DSTU2 (1.0.2)
* Support for all FHIR REST actions
* Pagination support for search results
* Batch and Transaction support
* Support for absolute, in-Bundle, and contained references
* Minimal dependencies
* Contemporary async/await structure
* Modern Class getter/setter
* Modern Class getter/setter pattern
* TDD with Mocha

# Example
# Examples

Examples using promises...

```javascript
const Client = require('../lib/client');
const Client = require('fhir-kit-client');

const fhirClient = new Client({ baseUrl: 'https://sb-fhir-stu3.smarthealthit.org/smartstu3/open' });

fhirClient.smartAuthMetadata().then((response) => {
Expand Down Expand Up @@ -180,19 +185,23 @@ DEBUG environment variable, or use `fhir-kit-client:*` to enable both.
$ DEBUG=fhir-kit-client:* node smart-launch.js
```

# TODO

* Search (on the system level)
* History (all three levels)

# Contributing

FHIRKit Client is an open source Node.js FHIR client library that welcomes community contributions with enthusiasm.
FHIRKit Client is an open source Node.js FHIR client library that welcomes
community contributions with enthusiasm.

All are welcome to participate. By participating in this project, you agree to
follow the [Code of
Conduct](https://github.com/Vermonster/fhir-kit-client/blob/master/CODE_OF_CONDUCT.md).

Please see our [Contributing](https://github.com/Vermonster/fhir-kit-client/blob/master/CONTRIBUTING.md) document for more details on how to get started.

# Todo

--
Please see our
[Contributing](https://github.com/Vermonster/fhir-kit-client/blob/master/CONTRIBUTING.md)
document for more details on how to get started.

# License

Expand Down
19 changes: 17 additions & 2 deletions package.json
@@ -1,7 +1,13 @@
{
"name": "fhir-client",
"name": "fhir-kit-client",
"version": "0.1.0",
"description": "FHIR Client",
"keywords": [
"FHIR",
"SMART",
"CDS Hooks",
"HL7"
],
"main": "lib/client.js",
"engines": {
"node": ">=8.10.0",
Expand All @@ -18,8 +24,17 @@
"coveralls": "nyc yarn test && nyc report --reporter=text-lcov | coveralls",
"coveralls:report": "nyc --reporter=lcov --reporter=text-lcov npm test"
},
"author": "",
"author": "Vermonster",
"license": "MIT",
"files": [
"LICENSE",
"README.md",
"lib/"
],
"repository": {
"type": "git",
"url": "https://github.com/Vermonster/fhir-kit-client.git"
},
"devDependencies": {
"chai": "^4.1.2",
"chokidar-cli": "^1.2.0",
Expand Down

0 comments on commit 47686ee

Please sign in to comment.