Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AfzalSabbir committed Nov 25, 2022
1 parent 2945e01 commit c2fc598
Showing 1 changed file with 54 additions and 3 deletions.
57 changes: 54 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,57 @@
# Vue SFC Vite - A Vue 3 SFC Vite template

> A package to create Vue 3 SFC Vite projects. \
<sub><sup>Inspired by [VueSFCRollup](https://github.com/team-innovation/vue-sfc-rollup)</sup></sub> \
**VueSFCRollup** was a great package to create SFC Rollup projects. But after there deprecation of the package, we decided to create a similar package for Vite.
> A package to create Vue 3 SFC Vite projects. <br/>
<sub><sup>Inspired by [VueSFCRollup](https://github.com/team-innovation/vue-sfc-rollup)</sup></sub> <br/>
**VueSFCRollup** was a great package to create SFC Rollup projects. But after there deprecation of the package, we
> decided to create a similar package for Vite.
> <br/><br/>
> Used [`Vite`](https://vitejs.dev/)/[`Library Mode`](https://vitejs.dev/guide/build.html#library-mode) configuration to
> create a single file component template for Vue 3 _(Supports Vue 2 as well)_.
> <br/><br/>
> `vue-sfc-vite` is a CLI templating utility that scaffolds a minimal setup for compiling a Vue Single File Component (
> SFC) - into a form ready to share via npm. It doesn't assume any particular flavor of CSS or docs generator, so you
> can use what you're already used to. It's the fastest way to produce npm-ready vue components!
## Installation

### Install globally

```bash
# Install globally (recommended)
npm install -g vue-sfc-vite
vue-sfc-vite
```

### **OR** use via npx

```bash
# For immediate, no-install usage
npx vue-sfc-vite
```

## Usage

```bash
# Fill in prompts

# Navigate to library folder
cd path/to/my-component-or-lib
npm install

# Do dev stuff
npm run serve

# Run build process
npm run build

# Ready to publish!
```

## Features

- 📦 **Single File Component** - Create a single file component for Vue 3.
- 📦 **Vue 2 Support** - Create a single file component for Vue 2.
- 📦 **Vue 3 Support** - Create a single file component for Vue 3.
- 📦 **Vue 3 Composition API** - Create a single file component for Vue 3 with Composition API.
- 📦 **Vue 3 Composition API + Vue 2 Support** - Create a single file component for Vue 3 with Composition API and Vue 2
Support.

0 comments on commit c2fc598

Please sign in to comment.