Skip to content

Commit 162c1e8

Browse files
committed
Update SDK developer readme
1 parent 6f4fe88 commit 162c1e8

File tree

2 files changed

+23
-6
lines changed

2 files changed

+23
-6
lines changed

README-sdk-dev.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1-
# Blue Button 2.0 SDK - Python Version
1+
# Blue Button 2.0 SDK Development Documentation
22

33
## Introduction
44

5-
Introduction goes here!
5+
This README contains information related to developing the SDK.
6+
7+
It is intended for BB2 team members or others performing SDK development work.
68

79
## Install Prerequisites:
810

@@ -35,10 +37,6 @@ To install the package file do the following:
3537
$ pip install <package file name>
3638
```
3739

38-
## Usage
39-
40-
Usage goes here!
41-
4240

4341
## Developing the Blue Button 2.0 SDK (for BB2 team SDK developers)
4442

@@ -133,5 +131,19 @@ To build the cms_bluebutton packages do the following:
133131

134132
The resulting distribution files with be created in the `dist/` directory.
135133

134+
### Install from a Package File
135+
136+
Package files can be installed via the following commands:
137+
138+
```bash
139+
pip install cms_bluebutton-0.1.0-py3-none-any.whl # wheel
140+
```
141+
or
142+
143+
```bash
144+
pip install cms_bluebutton-0.1.0.tar.gz # bdist
145+
```
136146

137147
### Publishing
148+
149+
TODO!

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
4. [Usages: Obtain Access Grant, Probe Scope, and Access Data](#usages)
99
5. [A Complete Sample App](#samples)
1010
6. [API Versions and Environments](#versions_and_environments)
11+
7. [SDK Development](#sdk_devel)
1112

1213
## Description <a name="description"></a>
1314

@@ -235,3 +236,7 @@ Web location of the environments:
235236
[PRODUCTION Environment: https://api.bluebutton.cms.gov](https://api.bluebutton.cms.gov)
236237

237238
[SANDBOX Environment: https://sandbox.bluebutton.cms.gov](https://sandbox.bluebutton.cms.gov)
239+
240+
## SDK Development <a name="sdk_devel"></a>
241+
242+
Documentation for BB2 team members and others developing the SDK can be found here: [README-sdk-dev.md](./README-sdk-dev.md)

0 commit comments

Comments
 (0)