@aaravpos/appointment-booking-plugin 2.0.1 → 2.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md ADDED
@@ -0,0 +1,100 @@
1
+ # @aaravpos/appointment-booking-plugin
2
+
3
+ React plugin for embedding the Aarav POS appointment booking system into your application.
4
+
5
+ ---
6
+
7
+ # Installation
8
+
9
+ Using npm:
10
+
11
+ ```bash
12
+ npm install @aaravpos/appointment-booking-plugin
13
+ ```
14
+
15
+ Using yarn:
16
+
17
+ ```bash
18
+ yarn add @aaravpos/appointment-booking-plugin
19
+ ```
20
+
21
+ ---
22
+
23
+ # Usage
24
+
25
+ Import the plugin into your React application.
26
+
27
+ ```jsx
28
+ import { AppointmentBookingPlugin } from "@aaravpos/appointment-booking-plugin";
29
+
30
+ function App() {
31
+ return (
32
+ <AppointmentBookingPlugin bookingCode={"QK9E2A"} />
33
+ );
34
+ }
35
+
36
+ export default App;
37
+ ```
38
+
39
+ ---
40
+
41
+ # Props
42
+
43
+ | Prop Name | Type | Required | Description |
44
+ | ------------ | ------ | -------- | ------------------------------------ |
45
+ | bookingCode | string | Yes | Unique booking code for appointment booking |
46
+
47
+ ---
48
+
49
+ # Example
50
+
51
+ ```jsx
52
+ import React from "react";
53
+ import { AppointmentBookingPlugin } from "@aaravpos/appointment-booking-plugin";
54
+
55
+ const App = () => {
56
+ return (
57
+ <div>
58
+ <AppointmentBookingPlugin bookingCode={"QK9E2A"} />
59
+ </div>
60
+ );
61
+ };
62
+
63
+ export default App;
64
+ ```
65
+
66
+ ---
67
+
68
+ # Requirements
69
+
70
+ - React 18+
71
+ - Node.js 16+
72
+
73
+ ---
74
+
75
+ # Features
76
+
77
+ - Easy integration
78
+ - Lightweight plugin
79
+ - Responsive booking UI
80
+ - Secure booking flow
81
+
82
+ ---
83
+
84
+ # Publish Package
85
+
86
+ ```bash
87
+ npm publish --access public
88
+ ```
89
+
90
+ ---
91
+
92
+ # License
93
+
94
+ MIT License
95
+
96
+ ---
97
+
98
+ # Support
99
+
100
+ For support and issues, contact the Aarav POS team.
@@ -0,0 +1,3 @@
1
+ import { default as React } from 'react';
2
+ import { AppointmentBookingPluginProps } from '../types';
3
+ export declare const AppointmentBookingPlugin: React.FC<AppointmentBookingPluginProps>;
@@ -1,3 +1,3 @@
1
1
  import { default as React } from 'react';
2
- import { BookingPluginProps } from '../types';
3
- export declare const BookingPluginContainer: React.FC<BookingPluginProps>;
2
+ import { AppointmentBookingPluginProps } from '../types';
3
+ export declare const BookingPluginContainer: React.FC<AppointmentBookingPluginProps>;