Skip to content

Commit

Permalink
📝 Updated readme file.
Browse files Browse the repository at this point in the history
  • Loading branch information
creador-dev committed May 29, 2023
1 parent 811f1d9 commit 0ada7c9
Showing 1 changed file with 9 additions and 17 deletions.
26 changes: 9 additions & 17 deletions packages/shared-notifications-banner/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
[![License: GPLv3](https://img.shields.io/badge/License-GPL%20v3-blue.svg?color=green)](http://www.gnu.org/licenses/gpl-3.0)
[![npm](https://img.shields.io/npm/v/@wpmudev/shared-notifications-discount)](https://www.npmjs.com/package/@wpmudev/shared-notifications-discount)
[![npm](https://img.shields.io/npm/v/@wpmudev/shared-notifications-banner)](https://www.npmjs.com/package/@wpmudev/shared-notifications-banner)

# Discount Notification
# Banner Notification

This package works as a **Shared Module** between [WPMU DEV](https://wpmudev.com/) plugins and it allows us to notify users about an special price for our products.

## Installation

```
npm i @wpmudev/shared-notifications-discount --save-dev
npm i @wpmudev/shared-notifications-banner --save-dev
```

## Usage
Expand All @@ -17,27 +17,23 @@ npm i @wpmudev/shared-notifications-discount --save-dev

```js
import React from 'react';
import { NoticeDiscount } from '@wpmudev/shared-notifications-discount';
import { NoticeBanner } from '@wpmudev/shared-notifications-banner';

import image1x from './sample-image.png';
import image2x from './[email protected]';

const MyApp = () => {
return (
<NoticeDiscount
price={65}
discount={20}
priceLabel="Pay Only"
priceTime="month"
title="Don't Miss Out On Subscription / Recurring Payment Support"
<NoticeBanner
title="Hosting by the Same People Behind Forminator!"
image={ image1x }
imageRetina={ image2x }
disclaimer="Only admin users can see this message"
buttonLabel="Get 20% Off Forminator Pro"
buttonLabel="Claim Your 50% Off Hosting Now!"
buttonLink="https://premium.wpmudev.com/"
>
<p>We'd hate for free users to miss out on Subscription / Recurring Payment Support, so we're temporarily slashing the price of Forminator Pro.</p>
</NoticeDiscount>
<p>Unleash the Full Power of Your Site with WPMU DEV Hosting! Lightning-Fast Speed, Robust Security, 24/7 Expert Support, and Effortless Ease of Use. Take Your Sites to the Next Level Today with 50% off the First Month!</p>
</NoticeBanner>
);
}
```
Expand All @@ -46,10 +42,6 @@ const MyApp = () => {

| Prop Name | Type | Description |
| --------- | ---- | ----------- |
| price | string | Set the base price to promote. |
| discount | string | Enter the amount to be discounted in percentage from `price`. |
| priceLabel | string | Highlight promotional price with catchy text. |
| priceTime | string | By default it is set to `month` for montly payments. |
| title* | string | Set a catchy title for notification. |
| image | string | When not empty, allows you to show an image at left of the main content. |
| imageRetina | string | Make sure image shows up correctly on bigger displays. |
Expand Down

0 comments on commit 0ada7c9

Please sign in to comment.