From 0bd7b2d62257a4402ec42fb339180cf2be8943ff Mon Sep 17 00:00:00 2001 From: andresin87 Date: Wed, 27 Sep 2023 23:15:27 +0200 Subject: [PATCH] feat(portal): doc --- packages/components/portal/LICENSE.md | 21 +++++++++++++++++++++ packages/components/portal/README.md | 13 +++++++++++++ packages/components/portal/package.json | 2 +- 3 files changed, 35 insertions(+), 1 deletion(-) create mode 100644 packages/components/portal/LICENSE.md create mode 100644 packages/components/portal/README.md diff --git a/packages/components/portal/LICENSE.md b/packages/components/portal/LICENSE.md new file mode 100644 index 000000000..88bd70f91 --- /dev/null +++ b/packages/components/portal/LICENSE.md @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) Adevinta ASA. + +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. \ No newline at end of file diff --git a/packages/components/portal/README.md b/packages/components/portal/README.md new file mode 100644 index 000000000..24d802e47 --- /dev/null +++ b/packages/components/portal/README.md @@ -0,0 +1,13 @@ +# Portal +> @spark-ui/portal + +![storybook](https://img.shields.io/badge/storybook-black?logo=storybook&link=https%3A%2F%2Fsparkui.vercel.app%2F%3Fpath%3D%2Fdocs%2Fcomponents-portal--docs) +![documentation](https://img.shields.io/badge/documentation-black?logo=googledocs&link=https%3A%2F%2Fsparkui-adv.vercel.app%2Fdocs%2Fcomponents%2Fportal) +![issue](https://img.shields.io/badge/report%20a%20bug-black?logo=openbugbounty&logoColor=red&link=https%3A%2F%2Fgithub.com%2Fadevinta%2Fspark%2Fissues%2Fnew%3F%26projects%3D4%26template%3Dbug-report.yml%26assignees%3D%26labels%3Dcomponent%2Cportal) +![npm](https://img.shields.io/npm/dt/%40spark-ui/portal?logo=npm&labelColor=black&link=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2F%40spark-ui%2Fportal) + + +This package is part of the [`@spark-ui`](https://github.com/adevinta/spark) react-js user interface component library project. + +![Issues open](https://img.shields.io/github/issues-search/adevinta/spark?query=is%3Aopen%20label%3Acomponent%20label%3Aportal&logo=openbugbounty&logoColor=red&label=issues%20open&color=red&link=https%3A%2F%2Fgithub.com%2Fadevinta%2Fspark%2Fissues%3Fq%3Dis%253Aopen%2Blabel%253Acomponent%2Blabel%253Aportal) +![NPM](https://img.shields.io/npm/l/%40spark-ui%2Fportal) diff --git a/packages/components/portal/package.json b/packages/components/portal/package.json index 2c4ed7fb4..9d3138391 100644 --- a/packages/components/portal/package.json +++ b/packages/components/portal/package.json @@ -42,7 +42,7 @@ "category": "components" }, "bugs": { - "url": "https://github.com/adevinta/spark/issues?q=label%3Acomponent+label%3Aportal" + "url": "https://github.com/adevinta/spark/issues?q=is%3Aopen+label%3Acomponent+label%3Aportal" }, "homepage": "https://sparkui.vercel.app", "license": "MIT"