Skip to content

Commit

Permalink
Update README.md (#180)
Browse files Browse the repository at this point in the history
Added:
- tailwind feature
- project description
- new cover image 
- shield icon for npm version
  • Loading branch information
Yordan-Ramchev authored Dec 20, 2023
1 parent 6a4a0b5 commit 1c26904
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
<h1>MentorMate/create-vue</h1>
<p>
<a href="https://npmjs.com/package/create-vue"><img src="https://badgen.net/npm/v/create-vue" alt="npm package"></a>
<a href="https://nodejs.org/en/about/releases/"><img src="https://img.shields.io/node/v/create-vue" alt="node compatibility"></a>
<a href="https://nodejs.org/en/about/releases/"><img src="https://img.shields.io/node/v/%40mentormate%2Fcreate-vue" alt="node compatibility"></a>
<a href="http://commitizen.github.io/cz-cli/"><img src="https://img.shields.io/badge/commitizen-friendly-brightgreen.svg" alt="Commitizen friendly"></a>
<a href="https://github.com/MentorMate/create-vue/actions/workflows/github-code-scanning/codeql"><img src="https://github.com/MentorMate/create-vue/actions/workflows/github-code-scanning/codeql/badge.svg" alt="CodeQL friendly"></a>
<a href="https://github.com/MentorMate/create-vue/actions/workflows/npm-publish-package.yml"><img src="https://github.com/MentorMate/create-vue/actions/workflows/npm-publish-package.yml/badge.svg" alt="Publish Package"></a>
</p>

<img width="878" alt="Screenshot 2023-10-31 at 13 26 13" src="https://github.com/MentorMate/create-vue/assets/69005114/12ca5a2d-1afb-4793-b115-77b410e0127e">
<img width="794" alt="Screenshot 2023-12-20 at 17 04 59" src="https://github.com/MentorMate/create-vue/assets/69005114/645aca7c-af75-4d05-b959-916ec9d7e1d1">

<p>
<a href="#key-features">Key Features</a> •
Expand All @@ -26,13 +26,16 @@ npx @mentormate/create-vue

## Key Features

Includes essential tools like Prettier, ESLint, and Husky to enforce code formatting, style consistency, and pre-commit hooks, as well as predefined VSCode settings and extensions, ensuring a streamlined and standardized Vue.js development experience within our organization

- All supported official create-vue features
- VueUse - Collection of Essential Vue Composition Utilities (<https://vueuse.org/>)
- Vue I18n - Internationalization plugin for Vue.js (<https://vue-i18n.intlify.dev/>)
- StoryBook - Frontend workshop for building UI components and pages in isolation (<https://storybook.js.org/>)
- SonarQube - The code quality tool for better code (<https://www.sonarsource.com/products/sonarqube/>)
- Husky - Modern native git hooks made easy (<https://typicode.github.io/husky/>)
- TanStack Query - Powerful asynchronous state management (<https://tanstack.com/query/latest>)
- TailwindCSS - An API for your design system (<https://tailwindcss.com/>)
- Please submit an <a href="https://github.com/MentorMate/create-vue/issues">issue</a> if you would like to see other features to be supported

## Contribution
Expand Down

0 comments on commit 1c26904

Please sign in to comment.