Skip to content

Commit

Permalink
license and release
Browse files Browse the repository at this point in the history
  • Loading branch information
aug2uag committed Sep 13, 2015
1 parent fa01142 commit a22d9c4
Show file tree
Hide file tree
Showing 4 changed files with 59 additions and 13 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2015

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
38 changes: 32 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,27 @@
# Guidelines
aug2uag © 2015

## General Purpose:
[![git][git-badge]][git-url]
[![npm][npm-badge]][npm-url]

* [Statement of Purpose](#purpose)
* [Access](#access)
* [Contributing](#contributing)
* [Disciplines](#disciplines)
* [TODO](#todo)
* [License](#license)

<a name="purpose"></a>
## Statement of Purpose:
* Centralize Guidelines for Clinical Practices
* Convenient Utilization of Guidelines for Applications and Interfaces
* Support Clinician Access to Guidelines
* Support Best Clinical Practices
* Support Patient Care and Rights

<a name="access"></a>
## Access:
S3 and/or other hosted article links provided in JSON XML and CSV formats

<a name="contributing"></a>
## Clinicians and Developers:
API access to files
* Get list of disciplines
Expand Down Expand Up @@ -44,15 +55,16 @@ create json file
"json": "$GUIDELINES"
}

run script.js
run [script.js][script]

$ npm install
$ node script.js

you may pass json as an argument if not saved to directory
you may pass json with [post.sh][post] as an argument if not saved to directory

$ sh ./post.sh '{"optional": "json"}'

<a name="disciplines"></a>
## Disciplines:
### `dental_guidelines` Purpose:
* Provide general guidelines for dental disciplines
Expand All @@ -74,8 +86,22 @@ you may pass json as an argument if not saved to directory
* Renal Disease in Dentistry
* Wheelchair Transfer Pocket Guide

<a name="todo"></a>
### Todo:
* Update guidelines
* Provide guidelines of other clinical practices and/or specialties
* Multiplatform scripts for pdf downloads
* Web and Mobile Applications
* Web and Mobile Applications

<a name="license"></a>
## License
aug2uag © 2015, Licensed under [MIT][].

[MIT]: ./LICENSE
[script]: ./script.js
[post]: ./post.sh

[git-badge]: https://img.shields.io/github/release/aug2uag/guidelines.svg?style=flat-square
[git-url]: https://github.com/aug2uag/guidelines/releases
[npm-badge]: https://img.shields.io/npm/v/guidelines.svg?style=flat-square
[npm-url]: https://npmjs.org/package/guidelines
3 changes: 1 addition & 2 deletions lib/utils.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@
// Guidelines
// aug2uag © 2015

var http = require('http')
, fs = require('fs')
var fs = require('fs')
, path = require('path')
, request = require('request')
, was = this;
Expand Down
10 changes: 5 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "Guidelines",
"name": "guidelines",
"version": "1.0.0",
"description": "Guidelines for clinicians.",
"main": "index.js",
Expand All @@ -19,7 +19,7 @@
},
"repository": {
"type": "git",
"url": "https://github.com/aug2uag/Guidelines"
"url": "https://github.com/aug2uag/guidelines"
},
"keywords": [
"guidelines",
Expand All @@ -30,9 +30,9 @@
"disease"
],
"author": "@aug2uag",
"license": "Attribution 4.0 International",
"license": "MIT",
"bugs": {
"url": "https://github.com/aug2uag/Guidelines/issues"
"url": "https://github.com/aug2uag/guidelines/issues"
},
"homepage": "https://github.com/aug2uag/Guidelines"
"homepage": "https://github.com/aug2uag/guidelines"
}

0 comments on commit a22d9c4

Please sign in to comment.