-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
KunaalAgarwal
committed
Mar 30, 2024
1 parent
08ec5f9
commit 347f901
Showing
2 changed files
with
21 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,23 @@ | ||
# Medicaid SDK | ||
Software Development Kit (SDK) to interact with the data.gov Medicaid API | ||
## [Availability](https://episphere.github.io/medicaid/) | ||
### [Interactive Observable Notebooks](https://observablehq.com/@medicaidsdk/overview) | ||
Explore the Observable Notebooks to view the MedicaidJS documentation and other pre-built tools! | ||
# MedicaidJS | ||
**MedicaidJS** is a versatile Software Development Kit (SDK) designed to facilitate seamless interaction with the [data.gov Medicaid API](https://www.medicaid.gov/). | ||
|
||
Refer to the [Episphere Github Repository](https://github.com/episphere/medicaid) for the most up to date and accurate version of this codebase. | ||
## Installation | ||
|
||
### Node.js Environment | ||
To integrate MedicaidJS into your Node.js project, use npm for installation: | ||
`npm install medicaid` or `npm ci medicaid` | ||
### Browser Environment | ||
For web-based projects, you can directly import MedicaidJS using ES6 module syntax: | ||
`const MedicaidSDK = await import('https://kunaalagarwal.github.io/medicaid/sdk.js');` | ||
|
||
## Resources | ||
### [Availability](https://episphere.github.io/medicaid/) | ||
Visit the landing page to explore the capabilities and the MedicaidJS ecosystem | ||
### [Publication](https://academic.oup.com/bioinformaticsadvances/article/3/1/vbad170/7455249?login=false) | ||
Refer to the published research article for more information about MedicaidJS. | ||
### [Tutorial](https://www.youtube.com/watch?v=5ie68NFGEHs) | ||
Comprehensive tutorial describing the best practices surrounding usage of MedicaidJS. | ||
|
||
Note that the "Official" version of the repository lives within the [Episphere Github Repository](https://github.com/episphere/medicaid). Check out this repository for production-ready features. | ||
|
||
## [Publication](https://academic.oup.com/bioinformaticsadvances/article/3/1/vbad170/7455249?login=false) | ||
Refer to the published article for more information about MedicaidJS | ||
|
||
## [Tutorial](https://www.youtube.com/watch?v=5ie68NFGEHs) | ||
Comprehensive tutorial describing the best practices surrounding usage of MedicaidJS. |