From ba1d23ce4970c1100cdeb1171d9f3e056015aa75 Mon Sep 17 00:00:00 2001 From: Nick Hellemans Date: Mon, 26 Feb 2024 22:22:59 +0100 Subject: [PATCH] chore(readme): update docs and add license --- LICENSE.md | 21 +++++++++++++++++++++ README.md | 25 +++++++++++++++++-------- 2 files changed, 38 insertions(+), 8 deletions(-) create mode 100644 LICENSE.md diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..f540ad9 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) Awell + +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. diff --git a/README.md b/README.md index 8271bb2..0a2a77a 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,10 @@ to perform clinically validated score calculations.

+

+ This project is licensed under the terms of the MIT license. +

+

Built with Typescript PRs welcome! @@ -17,14 +21,14 @@

Documentation · - Playground app - · API playground + · + Playground app

Awell Score is an API developed by the [Awell Health](http://awell.health/) team used to calculate validated scores for clinical & patient reported outcome measures or perform any other clinical algorithms. **The API currently has a library of over 100 validated scores.** -It was originally developed as an in-house microservice used by our own products. However, in September 2022 we decided to make the project open source and make it available to everyone. +It was originally developed as an in-house microservice used by our own products. However, in February 2024 we decided to open source the project and make it available to everyone. With Awell Score, you can avoid building clinical score calculations yourself which has a couple of benefits: @@ -39,6 +43,7 @@ With Awell Score, you can avoid building clinical score calculations yourself wh - [Documentation](#-documentation) - [Installation and running the app](#-installation-and-running-the-app) - [Test suite](#-test-suite) +- [License policy](#-license-policy) - [How to Contribute](#-how-to-contribute) ## 📜 Background @@ -70,10 +75,18 @@ The API is running on Node and built with Express and Typescript. NPM is used as ## 🧪 Test suite -All calculations are covered with an extensive test suite to make sure the results are reliable and valid. This is required because the Awell hosted version of the API is a medical device class Ia. +All calculations are covered with an extensive test suite to make sure the results are reliable and valid. Run all tests via the `npm run test` command. +## 🪪 License policy + +This open-source library supports calculations for various clinical questionnaires, some of which may have licensing requirements. **Users are responsible for ensuring they have the appropriate licenses** to use these questionnaires. + +We do not provide licenses for the questionnaires nor manage licensing on your behalf. Failure to secure necessary licenses or comply with their terms is solely the user's liability. + +Please ensure you have all necessary permissions before using this library. + ## 👏 How to Contribute The main purpose of this repository is to continue evolving Awell Score together with the healthcare community. @@ -90,10 +103,6 @@ The first version of the API - which was only used by Awell internally - was bui However, not all code passed Typescript's validation and quite some `//@ts-expect-error` comments had to be added in several places. Removing all of the errors will take some time and will be a gradual and progressive effort. There's a high confidence that there's no impact on the reliability & validity of scores given the extensive test coverage that is present. -### Roadmap - -We would love to hear ideas from you on how to improve the API and add functionality. Currently no major features, besides adding new calculations & maintaining the current ones, are planned. - ### Contributors ✨ Awell Score was made possible by the following people: