소스 검색

修改readme

zhuwei 5 년 전
부모
커밋
b96d0cd5e7
2개의 변경된 파일37개의 추가작업 그리고 4개의 파일을 삭제
  1. 36 3
      README.md
  2. 1 1
      package.json

+ 36 - 3
README.md

@@ -1,4 +1,37 @@
-# excel-preview
-纯前端展示excel表格
+jQuery excelPreview Plugin (https://github.com/sumile-ting/excel-preview)
 
-运行前,使用npm install安装所需依赖包
+选择一个excel文件,将所选得excel表格展示在页面上
+
+Install excel-preview and dependencies
+
+npm install excel-preview --save
+Include jquery and table2excel in your page
+
+<script src="node_modules/jquery/dist/jquery.min.js" type="text/javascript"></script>
+<script src="node_modules/bootstrap/dist/js/bootstrap.min.js" type="text/javascript"></script>
+<script src="node_modules/bootstrap-table/dist/bootstrap-table.min.js" type="text/javascript"></script>
+<script src="node_modules/bootstrap-table/dist/locale/bootstrap-table-zh-CN.min.js" type="text/javascript"></script>
+<script src="node_modules/xlsx-style/dist/xlsx.full.min.js" type="text/javascript"></script>
+<script src="js/dist/excel-preview.min.js"></script>
+
+
+Using the plugin
+$("#yourExcelTable").excelPreview({});
+
+index.html
+Contains a simple HTML file to demonstrate the plugin.
+
+dist/
+This is where the generated files are stored once gulp runs.
+
+gulpfile.js
+Contains all automated tasks using fulp.
+
+
+package.json
+Specify all dependencies loaded via Node.JS.
+
+Check NPM for more details.
+
+License
+MIT License

+ 1 - 1
package.json

@@ -1,5 +1,5 @@
 {
-  "name": "excelpreview",
+  "name": "excel-preview",
   "version": "1.0.0",
   "description": "Preview Excel online",
   "main": "index.js",