From 6e00d017015908da8d76713c30b92d549a330e41 Mon Sep 17 00:00:00 2001
From: Akkariin Meiko <akkariins@gmail.com>
Date: Sat, 3 Aug 2019 11:48:36 +0800
Subject: [PATCH] Update README.md

---
 README.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 54 insertions(+)

diff --git a/README.md b/README.md
index 191a6b5..aba2ac9 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,56 @@
 # YumV
 YumV is a FiveM server script, you can use it to install plugin, vehicle and maps quickly, like use the yum in CentOS.
+
+## Feature
+- Auto install plugin, vehicle, maps, peds or other.
+- Search the anything you want.
+- Remove the exist plugin.
+- Update the exist plugin to new version.
+- Show the installed plugin list.
+
+## Installation
+First, goto your FXServer resources directory, such as `/home/akkariin/fivem/resources/`.
+```
+cd /home/akkariin/fivem/resources/
+```
+Then, clone this project to your resources directory.
+```
+git clone https://github.com/kasuganosoras/YumV yum/
+```
+Edit your `server.cfg` and append the following text:
+```
+start yum
+add_ace resource.yum command.refresh allow
+```
+Final, restart your FXServer, enjoy!
+
+## Example use
+Install the vehicle "gtr":
+```
+yum install gtr
+```
+Search the vehicle "bmw":
+```
+yum search bmw
+```
+Update local plugin "vMenu":
+```
+yum update vMenu
+```
+Remove an exist plugin "subwrx":
+```
+yum remove subwrx
+```
+List all the plugins you installed:
+```
+yum list
+```
+You can use command `yum help` for help.
+
+## Upload
+If you want to upload a new resource to YumV mirror, you can visit: https://yumv.net/ (Chinese website)
+
+You need to register an account to upload files.
+
+## License
+This project is open-source, use GPL-v3 license.