Skip to content

Commit

Permalink
initial release
Browse files Browse the repository at this point in the history
  • Loading branch information
iqbal-rashed committed Dec 15, 2023
1 parent f65365e commit caa4765
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 5 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ body:
options:
- label: Check if you're on the [latest React-Peel version](https://github.com/iqbal-rashed/react-peel/releases/latest).
required: true
- label: Read the [docs](https://example.vercel).
- label: Read the [docs](https://iqbal-rashed.github.io/react-peel).
required: true
- label: Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.
required: true
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ body:
label: Validations
description: Before submitting the issue, please make sure you do the following
options:
- label: Read the [docs](https://example.vercel).
- label: Read the [docs](https://iqbal-rashed.github.io/react-peel).
required: true
- label: Read the [Contributing Guidelines](https://github.com/iqbal-rashed/react-peel/blob/main/.github/contributing.md).
required: true
Expand Down
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2023 Rashed Iqbal

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.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@

## About

_This is a React wrapper around the peel.js library originally created by Andrew Plummer in 2014._
_This is a React wrapper around the [peel.js](https://github.com/andrewplummer/peel-js) library originally created by Andrew Plummer in 2014._

## **Check out the docs at https://example.docs**
## **Check out the docs at https://iqbal-rashed.github.io/react-peel**

## Installation

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
"bugs": {
"url": "https://github.com/iqbal-rashed/react-peel/issues"
},
"homepage": "https://github.com/iqbal-rashed/react-peel",
"homepage": "https://iqbal-rashed.github.io/react-peel",
"peerDependencies": {
"react": "16.8.0 || >=17.x || >=18.x",
"react-dom": "16.8.0 || >=17.x || >=18.x"
Expand Down

0 comments on commit caa4765

Please sign in to comment.