yi-hello-npm
v1.0.7
Published
A simple TypeScript-written package
Downloads
3
Readme
Creating a comprehensive README file that covers usage for various scenarios (CDN, Vue CDN, Vue CLI, and Nuxt.js) involves providing clear and structured instructions. Below is a template you can use for your README file:
Your Library Name
Brief description of your library.
Table of Contents
CDN Usage
Installation
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/bundle.umd.js" defer></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/bundle.umd.css">Script Include
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>CDN Usage Example</title>
<script src="https://unpkg.com/[email protected]/dist/vue.global.prod.js"></script>
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/bundle.umd.js" defer></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/bundle.umd.css">
</head>
<body>
<div id="app">
<h1>CDN Usage Example</h1>
<button @click="openPopup">Open Popup</button>
</div>
<script>
const app = Vue.createApp({
methods: {
openPopup() {
const popup = new PopupModal.PopupModal('Mengyi');
popup.open();
}
}
});
app.mount('#app');
</script>
</body>
</html>Vue CDN Usage
Script Include
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Vue CDN Usage Example</title>
<script src="https://unpkg.com/[email protected]/dist/vue.global.prod.js"></script>
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/bundle.umd.js" defer></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/bundle.umd.css">
</head>
<body>
<div id="app">
<h1>Vue CDN Usage Example</h1>
<button @click="openPopup">Open Popup</button>
</div>
<script>
const app = Vue.createApp({
methods: {
openPopup() {
const popup = new PopupModal.PopupModal('Mengyi');
popup.open();
}
}
});
app.mount('#app');
</script>
</body>
</html>Vue CLI Usage
Installation
npm install yi-hello-npmUsage in Vue Components
<template>
<div>
<h1>Vue CLI Usage Example</h1>
<button @click="openPopup">Open Popup</button>
</div>
</template>
<script setup>
import { ref } from 'vue';
import { PopupModal } from 'yi-hello-npm';
import 'yi-hello-npm/dist/bundle.umd.css';
const popupModal = new PopupModal('Mengyi');
function openPopup() {
popupModal.open();
}
</script>
<style>
/* Add any additional styles here */
</style>Nuxt.js Usage
Installation
npm install yi-hello-npmConfiguration
nuxt.config.js
export default {
// Other configurations...
plugins: [
'~/plugins/yi-hello-npm.js'
]
}plugins/yi-hello-npm.js
import { PopupModal } from 'yi-hello-npm';
import 'yi-hello-npm/dist/bundle.umd.css';
export default defineNuxtPlugin((nuxtApp) => {
nuxtApp.provide('popupModal', PopupModal);
});Usage in Components
<template>
<div>
<h1>Nuxt.js Usage Example</h1>
<button @click="openPopup">Open Popup</button>
</div>
</template>
<script setup>
import { useNuxtApp } from '#app';
const { $popupModal } = useNuxtApp();
function openPopup() {
const popup = new $popupModal('Mengyi');
popup.open();
}
</script>
<style>
/* Add any additional styles here */
</style>License
[License details, e.g., MIT License]
Notes:
- Update URLs (
[email protected]) with the latest version or specific version you are using. - Adjust paths and configurations based on your specific project setup.
This template covers various scenarios for integrating your library (yi-hello-npm) into different environments: CDN, Vue CDN, Vue CLI, and Nuxt.js. Adjust the details as per your specific library and project requirements.