sherick-ui 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.
Files changed (2) hide show
  1. package/README.md +25 -29
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,36 +1,32 @@
1
- This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
1
+ # Sherick UI
2
2
 
3
- ## Getting Started
3
+ Sherick UI is a collection of UI components for React inspired by Material Design. This package provides a suite of reusable components aimed at enhancing the development of user interfaces in React applications.
4
4
 
5
- First, run the development server:
5
+ ## Components
6
6
 
7
- ```bash
8
- npm run dev
9
- # or
10
- yarn dev
11
- # or
12
- pnpm dev
13
- # or
14
- bun dev
15
- ```
16
-
17
- Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
18
-
19
- You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
20
-
21
- This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
7
+ The package includes the following components:
22
8
 
23
- ## Learn More
9
+ - **ActionButton**: A versatile button component for user interactions.
10
+ - **Avatar**: A component for displaying user profile pictures or icons.
11
+ - **Badge**: A badge component for displaying count or status.
12
+ - **Card**: A card component to group related content.
13
+ - **Dropdown**: A dropdown menu for selecting options.
14
+ - **Search**: A search input component.
15
+ - **Input**: A standard input field for forms.
16
+ - **Textarea**: A multi-line input field.
17
+ - **Tooltip**: A component for displaying hover tooltips.
18
+ - **Modal**: A modal dialog for displaying content over the application.
19
+ - **Spinner**: A loading spinner to indicate ongoing processes.
20
+ - **Markdown**: A component for rendering Markdown content.
21
+ - **Alert**: A notification or alert message component.
22
+ - **Skeleton**: A placeholder loading component.
23
+ - **Switch**: A toggle switch component.
24
+ - **TabGroup**: A component for tab navigation.
25
+ - **Table**: A table component for displaying data.
24
26
 
25
- To learn more about Next.js, take a look at the following resources:
27
+ ## Installation
26
28
 
27
- - [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
28
- - [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
29
+ You can install the package via npm:
29
30
 
30
- You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
31
-
32
- ## Deploy on Vercel
33
-
34
- The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
35
-
36
- Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
31
+ ```bash
32
+ npm install sherick-ui
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "sherick-ui",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "A collection of UI components for React inspired by Material Design.",
5
5
  "keywords": [
6
6
  "react",