From c0541e01a00f547850968edfd4f49f650821b09c Mon Sep 17 00:00:00 2001 From: Safraz Razik Date: Wed, 18 Dec 2019 01:31:14 +0530 Subject: [PATCH] Update README --- README.md | 131 ++++++++++++++++++++++++++---------------------------- 1 file changed, 62 insertions(+), 69 deletions(-) diff --git a/README.md b/README.md index 5249df4..e9801b7 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Vue File Agent -> Every file deserves to be treated equally +> Every file deserves to be treated equally High performant Vue file **upload** component with elegant and distinguishable **previews** for every file type and support for **drag and drop**, **validations**, default uploader with **progress** support and externally customizable in the "vue way" @@ -8,8 +8,7 @@ High performant Vue file **upload** component with elegant and distinguishable * ## [Live Demo][] ยท [CodePen Playground](https://codepen.io/safrazik/pen/BaBpYme) -![Demo](website/assets/demo.gif) - +![Demo](website/assets/demo.gif?v=1.5) ## Features @@ -22,7 +21,7 @@ High performant Vue file **upload** component with elegant and distinguishable * - Max File Size, Accepted file types validation - Image/Video/Audio Previews - File type icons -- Default uploader with progress +- Default uploader with progress - Externally controllable via Vue bindings and methods - Built in support for server side validation and error handling - Official [Upload Server Examples](upload-server-examples) for **PHP** and **Node Js** @@ -31,21 +30,18 @@ High performant Vue file **upload** component with elegant and distinguishable * - Resumable uploads with `:resumable` prop through [tus.io](https://tus.io) protocol - Can be used with any css/component framework, including but not limited to: Bootstrap, Bulma, Tailwind, Vuetify, etc. - ## Basic Usage - + ```html ``` + **NOTE:** when `uploadUrl` is provided, auto uploading is enabled. See [Advanced Usage](#advanced-usage) section below for manual uploading example. @@ -53,25 +49,26 @@ High performant Vue file **upload** component with elegant and distinguishable * + ```html ``` ### That's it? -Yes. That's it. It's *that* simple. See [Advanced Usage](#advanced-usage) section below to tailor it for your specific needs. +Yes. That's it. It's _that_ simple. See [Advanced Usage](#advanced-usage) section below to tailor it for your specific needs. ## Installation @@ -90,22 +87,22 @@ Vue.use(VueFileAgent); or with script tag ```html - - - + + + - - - + + + ``` [Download from Github](https://github.com/safrazik/vue-file-agent/releases) ## Advanced Usage - + ```html ``` + + ```html ``` @@ -181,8 +176,6 @@ export default { The MIT License - ## [Live Demo][] - -[Live Demo]: https://safrazik.github.io/vue-file-agent +[live demo]: https://safrazik.github.io/vue-file-agent