From 0fe3b99260bc6037a1f08ef063e08d88209ae2b1 Mon Sep 17 00:00:00 2001 From: Gooddevil Date: Sat, 30 Nov 2024 22:06:20 +0330 Subject: [PATCH 1/3] Update Reaadme file and add it to the files in the package.json --- .cspell.json | 6 +++++- README.md | 34 ++++++++++++++++------------------ package.json | 4 ++++ 3 files changed, 25 insertions(+), 19 deletions(-) diff --git a/.cspell.json b/.cspell.json index 7ffe5bf..f1b66e9 100644 --- a/.cspell.json +++ b/.cspell.json @@ -5,11 +5,15 @@ "clsx", "fullstacksjs", "mobily", + "Shadcn", "tailwindcss", "tsbuildinfo", "tseslint", "typecheck" ], "language": "en", - "ignorePaths": ["node_modules", "pnpm-lock.yaml"] + "ignorePaths": [ + "node_modules", + "pnpm-lock.yaml" + ] } diff --git a/README.md b/README.md index d092b62..09af859 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,8 @@ -Here’s a **README.md** file for your `anotherUI` project: +# AnotherUI ---- - -# anotherUI +AnotherUI is a UI component library built on top of **Shadcn** and **Tailwind CSS**. This project is designed only for learning purpose and it's open to contributions for people like me who want to learn how implement a simple library with React. -A modern UI component library built with **Vite**, **pnpm**, and **Tailwind CSS**. This project is designed to be developer-friendly, customizable, and open to contributions. - -## Table of Contents +## Table of Contents πŸ“ƒ - [Folder Structure](#folder-structure) - [Tech Stack](#tech-stack) @@ -19,7 +15,7 @@ A modern UI component library built with **Vite**, **pnpm**, and **Tailwind CSS* --- -## Folder Structure +## Folder Structure πŸ“‚ The project structure is organized as follows: @@ -41,7 +37,7 @@ The project structure is organized as follows: --- -## Tech Stack +## Tech Stack βš™οΈ - **Vite**: Build tool for fast and optimized development. - **pnpm**: Efficient package manager for monorepos. @@ -49,7 +45,7 @@ The project structure is organized as follows: --- -## Prerequisites +## Prerequisites πŸ›’ To work on or use this project, ensure you have: @@ -66,7 +62,7 @@ To work on or use this project, ensure you have: --- -## Installation +## Installation πŸ’Ύ 1. Clone the repository: @@ -88,7 +84,7 @@ To work on or use this project, ensure you have: --- -## Using anotherUI in Your Project +## Using anotherUI in Your Project ⛓️‍πŸ’₯ To integrate this library into your project: @@ -120,9 +116,9 @@ To integrate this library into your project: --- -## Contributing +## Contributing 🀝 -We welcome contributions from the community! Follow these steps to get started: +As I mentioned, This is a personal project, but I welcome contributions from the community! Follow these steps to get started: 1. **Fork the Repository**: @@ -132,7 +128,7 @@ We welcome contributions from the community! Follow these steps to get started: - Create a branch for your changes: ```bash - git checkout -b feature/your-branch-name + git checkout -b your-branch-name ``` 3. **Make Changes**: @@ -143,7 +139,7 @@ We welcome contributions from the community! Follow these steps to get started: - Push your branch: ```bash - git push origin feature/your-branch-name + git push origin your-branch-name ``` - Create a Pull Request (PR) to the `main` branch of the original repository. @@ -152,7 +148,7 @@ We welcome contributions from the community! Follow these steps to get started: --- -## Commit Guidelines +## Commit Guidelines 🏷️ Follow these commit message conventions (present tense, Linux style): @@ -171,9 +167,11 @@ Follow these commit message conventions (present tense, Linux style): - **Introduce**: For introducing new patterns, plugins, or systems. Example: `Introduce new token system in twPlugin` +and so on... + --- -## Design Tokens +## Design Tokens 🎨 The `twPlugin` directory includes: diff --git a/package.json b/package.json index e3307d0..bd4f349 100644 --- a/package.json +++ b/package.json @@ -6,6 +6,10 @@ "type": "module", "main": "./index.js", "types": "./src/index.d.ts", + "files": [ + "dist/", + "README.md" + ], "keywords": [ "anotherUI,React", "Tailwind", From e7f5125b6bfe300877f451eed159cc9e35f0d5a0 Mon Sep 17 00:00:00 2001 From: Gooddevil Date: Sat, 30 Nov 2024 22:07:51 +0330 Subject: [PATCH 2/3] Release: v0.0.3-0 --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index bd4f349..4399baa 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "another-ui", "description": "as the name says, it's another ui library for React built on Tailwind & Shadcn", "author": "Gooddevil", - "version": "0.0.2", + "version": "0.0.3-0", "type": "module", "main": "./index.js", "types": "./src/index.d.ts", From addea136b2b5d1920ee8d17d9df0665b0e6785dc Mon Sep 17 00:00:00 2001 From: Gooddevil Date: Sat, 30 Nov 2024 22:12:20 +0330 Subject: [PATCH 3/3] Release: v0.0.3-beta.0 --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 4399baa..1fb4ec9 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "another-ui", "description": "as the name says, it's another ui library for React built on Tailwind & Shadcn", "author": "Gooddevil", - "version": "0.0.3-0", + "version": "0.0.3-beta.0", "type": "module", "main": "./index.js", "types": "./src/index.d.ts",