Skip to content

Commit 23a14b5

Browse files
abrahamcalsinabrahamcalsin
committed
docs: ✏️ README.md updated
1 parent 42dd7e1 commit 23a14b5

3 files changed

Lines changed: 50206 additions & 9 deletions

File tree

‎README.md‎

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
11
# React GitHub Fork Banner
22

3+
<p align="left">
4+
<a href="https://www.npmjs.com/package/react-github-fork-banner">
5+
<img src="https://img.shields.io/npm/v/react-github-fork-banner.svg?style=flat-square" alt="Current Release" />
6+
</a>
7+
<a href="https://www.npmjs.com/package/react-github-fork-banner">
8+
<img src="https://badgen.net/npm/dt/react-github-fork-banner?style=flat-square" alt="Downloads" />
9+
</a>
10+
<a href="https://github.com/abrahamcalsin/github-fork-banner/blob/main/LICENSE">
11+
<img alt="npm" src="https://img.shields.io/npm/l/react-github-fork-banner?style=flat-square" alt="License">
12+
</a>
13+
</p>
14+
315
<code>react-github-fork-banner</code> is an npm package that allows you to add a github banner with a link linked to your project's fork or repository. You can give it a super custom use as a normal react component.
416

517
#
@@ -32,6 +44,7 @@ function App() {
3244
<GithubForkBanner
3345
direction=""
3446
size={}
47+
animation=""
3548
customHref="https://github.com/username/repo"
3649
bannerColor=""
3750
octoColor=""
@@ -47,13 +60,14 @@ Fill in the missing values for each property.
4760

4861
These are the properties that can be added:
4962

50-
| Property Name | Type | Default Value | Values you can use | Description |
51-
| :-----------: | :----: | :-----------: | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
52-
| direction | String | 'right' | "left" and "right". | Define the Banner direction. |
53-
| size | Number | 98 | Only numeric type values | Define the width and height of the Banner. |
54-
| customHref | String | '/' | Links href | This field is mandatory, you will get an error if you do not add its value, this to avoid giving an inadequate and useless use to the component. |
55-
| bannerColor | String | '#000' | HEX, HSL, CSS( RGB & RGBA ) | Define the color of the Banner. |
56-
| octoColor | String | '#fff' | HEX, HSL, CSS( RGB & RGBA ) | Defines the color of the Octocat. |
63+
| Property Name | Type | Default Value | Values you can use | Description |
64+
| :-----------: | :----: | :-----------: | --------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
65+
| direction | String | 'right' | "left" and "right" | Define the Banner direction. |
66+
| size | Number | 98 | Only numeric type values | Define the width and height of the Banner. |
67+
| animation | String | none | left-ear, right-ear, ears, tail, tail-&-leftEar, tail-&-rightEar, all | Define the Octocat animation. |
68+
| customHref | String | '/' | Links href | This field is mandatory, you will get an error if you do not add its value, this to avoid giving an inadequate and useless use to the component. |
69+
| bannerColor | String | '#000' | HEX, HSL, CSS( RGB & RGBA ) | Define the color of the Banner. |
70+
| octoColor | String | '#fff' | HEX, HSL, CSS( RGB & RGBA ) | Defines the color of the Octocat. |
5771

5872
#
5973

0 commit comments

Comments
 (0)