Skip to content

Commit

Permalink
upated markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
hackcharms committed Nov 7, 2023
1 parent 868c5d5 commit ed6f016
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 23 deletions.
29 changes: 7 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,3 @@
# Vue 3 + TypeScript + Vite

This template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.

## Recommended IDE Setup

- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).

## Type Support For `.vue` Imports in TS

TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types.

If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps:

1. Disable the built-in TypeScript Extension
1. Run `Extensions: Show Built-in Extensions` from VSCode's command palette
2. Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.
3.

# Index

- [Introduction](#introduction)
Expand All @@ -31,11 +11,16 @@ If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has a
- [Examples](#examples)

# Introduction
`vue3-toaster` is a VueJs 3 package for toasting/notification for the web page. It's light weight no external dependency and fully customizable. It has easy to use composable and plug in that can be directly use.
Revolutionize your Vue.js 3 development with `vue3-toaster`, a lightweight and fully customizable toast notification package that seamlessly blends into your design, requiring zero third-party dependencies for a cleaner bundle size and offering effortless customization to match your exact design requirements.
Easily integrate toast notifications into your Vue.js components and tailor their look and feel to match your exact requirements.
Easy-to-use composables and plugins for effortless integration.

# How to use
There are multiple way to use `vue3-toaster` package
- [Register as plugin](#Register-as-plugin)
- [Direct import](#Direct-import)
## Register as plugin
## using composable
## Direct import

# Interfaces

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@
},
"license": "MIT",
"author": "hackcharms<zaa78692@gmail.com>",
"description": "🎉🔔 Vue 3 ${packageName} is light weight 100% customizable and no third party dependencies package.",
"description": "🎉🔔 Revolutionize your Vue.js 3 development with a toast notification package that seamlessly blends into your design, requiring zero third-party dependencies and offering effortless customization.",
"keywords": [
"vue",
"vue3",
Expand Down

0 comments on commit ed6f016

Please sign in to comment.