From a518eb19da86c59fea498f31882ab3638bc7dc2d Mon Sep 17 00:00:00 2001 From: TheoryOfNekomata Date: Sun, 26 Jul 2020 11:57:07 +0800 Subject: [PATCH] Add README, LICENSE Put additional links in README. Also, re-license library to MIT. --- LICENSE | 14 ++++++++++++++ README.md | 8 ++++++++ package.json | 2 +- 3 files changed, 23 insertions(+), 1 deletion(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..216c690 --- /dev/null +++ b/LICENSE @@ -0,0 +1,14 @@ +Copyright 2020 TheoryOfNekomata (https://modal.sh) + +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 0978ba4..4727988 100644 --- a/README.md +++ b/README.md @@ -81,3 +81,11 @@ ReactDOM.render( window.document.body.appendChild(mountNode) ``` + +Detailed usage guides can be found in the [Tesseract Design - React Common documentation](https://make.modal.sh/tesseract/web/react/common). + +## TypeScript + +The package is written and tested using TypeScript. Thus, typings for consumption in TypeScript are bundled with the +compiled source. + diff --git a/package.json b/package.json index abd94f2..ac9b465 100644 --- a/package.json +++ b/package.json @@ -9,7 +9,7 @@ "types": "dist/lib/index.d.ts", "repository": "https://code.modal.sh/tesseract-design/react-common.git", "author": "TheoryOfNekomata ", - "license": "UNLICENSED", + "license": "MIT", "private": false, "devDependencies": { "@rollup/plugin-typescript": "^5.0.2",