goji-search 1.0.0 → 1.0.1
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 +6 -53
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,70 +1,23 @@
|
|
|
1
|
-
# Goji
|
|
2
|
-
|
|
3
|
-
A lightweight React component library providing embeddable form and button components for seamless integration into your React applications.
|
|
4
|
-
|
|
5
|
-
## Features
|
|
6
|
-
|
|
7
|
-
- **Embeddable Form**: Easily add a customizable form to your app.
|
|
8
|
-
- **Embeddable Button**: Simple, reusable button component.
|
|
9
|
-
- **TypeScript Support**: Fully typed for a great developer experience.
|
|
10
|
-
- **Zero Dependencies**: Only requires React as a peer dependency.
|
|
1
|
+
# Goji Search
|
|
11
2
|
|
|
12
3
|
## Installation
|
|
13
4
|
|
|
14
5
|
```bash
|
|
15
|
-
npm install goji-
|
|
6
|
+
npm install goji-search
|
|
16
7
|
# or
|
|
17
|
-
yarn add goji-
|
|
8
|
+
yarn add goji-search
|
|
18
9
|
```
|
|
19
10
|
|
|
20
11
|
## Usage
|
|
21
12
|
|
|
22
13
|
```tsx
|
|
23
|
-
import {
|
|
14
|
+
import { GojiSearchComponent } from 'goji-search';
|
|
24
15
|
|
|
25
16
|
function App() {
|
|
26
17
|
return (
|
|
27
18
|
<div>
|
|
28
|
-
<
|
|
29
|
-
<GojiEmbedButton /* props here */ />
|
|
19
|
+
<GojiSearchComponent /* props here */ />
|
|
30
20
|
</div>
|
|
31
21
|
);
|
|
32
22
|
}
|
|
33
|
-
```
|
|
34
|
-
|
|
35
|
-
## Components
|
|
36
|
-
|
|
37
|
-
### `<GojiEmbedForm />`
|
|
38
|
-
|
|
39
|
-
A form component for embedding in your React app.
|
|
40
|
-
|
|
41
|
-
**Props:**
|
|
42
|
-
*(Document your props here, e.g. onSubmit, fields, etc.)*
|
|
43
|
-
|
|
44
|
-
---
|
|
45
|
-
|
|
46
|
-
### `<GojiEmbedButton />`
|
|
47
|
-
|
|
48
|
-
A reusable button component.
|
|
49
|
-
|
|
50
|
-
**Props:**
|
|
51
|
-
*(Document your props here, e.g. onClick, label, etc.)*
|
|
52
|
-
|
|
53
|
-
---
|
|
54
|
-
|
|
55
|
-
## Development
|
|
56
|
-
|
|
57
|
-
- Built with [Vite](https://vitejs.dev/) and [TypeScript](https://www.typescriptlang.org/).
|
|
58
|
-
- To build the library:
|
|
59
|
-
```bash
|
|
60
|
-
npm run build
|
|
61
|
-
```
|
|
62
|
-
|
|
63
|
-
## License
|
|
64
|
-
|
|
65
|
-
MIT
|
|
66
|
-
|
|
67
|
-
---
|
|
68
|
-
|
|
69
|
-
*Feel free to open issues or pull requests for improvements or bug fixes!*
|
|
70
|
-
*creating dev branch*
|
|
23
|
+
```
|