readme

Author: ktsn

README.md

@@ -1,6 +1,26 @@
-# template-node
+# Vue CLI Plugin MFC
 
-A project template for Node.js libraries.
+Vue CLI plugin for multiple file component projects.
+
+## What is MFC (Multiple File Component)?
+
+It is opposite thing of single file component (SFC). While SFC includes all things in one file (`.vue` file), MFC splits a component in separated files:
+
+```
+└── App
+    ├── App.css
+    ├── App.html
+    └── App.js
+```
+
+`vue-cli-plugin-mfc` helps you to construct your project with MFCs by using [vue-template-loader](https://github.com/ktsn/vue-template-loader) on the internal webpack config in Vue CLI service.
+
+## Installation
+
+```sh
+# make sure you already installed @vue/cli
+$ vue add mfc
+```
 
 ## License
 

package.json

@@ -1,7 +1,7 @@
 {
   "name": "vue-cli-plugin-mfc",
   "version": "0.0.0",
-  "description": "",
+  "description": "Vue CLI plugin for multiple file component projects",
   "main": "index.js",
   "files": [
     "generator",
@@ -11,7 +11,13 @@
     "type": "git",
     "url": "git+https://github.com/ktsn/vue-cli-plugin-mfc.git"
   },
-  "keywords": [],
+  "keywords": [
+    "Vue",
+    "Vue CLI",
+    "Vue CLI plugin",
+    "multiple file component",
+    "vue-template-loader"
+  ],
   "author": "katashin",
   "license": "MIT",
   "bugs": {