From 5ef5bf4167628067e8e44fc62e94f9eb205b25ea Mon Sep 17 00:00:00 2001
From: mawen1250 <mawen1250@gmail.com>
Date: Mon, 29 Nov 2021 11:21:24 +0800
Subject: [PATCH] Update README

---
 README.md | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 2e4ef28..c97cb43 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,7 @@
 # nnedi3_resample
 
+A VapourSynth script for easy resizing using nnedi3/znedi3/nnedi3cl with center alignment and correct chroma placement.
+
 ## Requirements
 
 - [nnedi3](https://github.com/dubhater/vapoursynth-nnedi3) / [znedi3](https://github.com/sekrit-twc/znedi3) / [nnedi3cl](https://github.com/HomeOfVapourSynthEvolution/VapourSynth-NNEDI3CL)
@@ -8,7 +10,9 @@
 
 ## Usage
 
-Put nnedi3_resample.py into `<python folder>\Lib\site-packages`
+For Windows users, put nnedi3_resample.py into
+- VapourSynth installed for all users: `<python folder>\Lib\site-packages`
+- VapourSynth installed for current user: `%AppData%\Python\Python<version>\site-packages`
 
 ## Function
 
@@ -23,10 +27,10 @@ Double the width and height of a clip.
 ```python
 import vapoursynth as vs
 from vapoursynth import core
-import nnedi3_resample as nnrs
+from nnedi3_resample import nnedi3_resample
 
 clip = XXXSource()
-clip = nnrs.nnedi3_resample(clip, clip.width * 2, clip.height * 2, mode='znedi3')
+clip = nnedi3_resample(clip, clip.width * 2, clip.height * 2, mode='znedi3')
 
 clip.set_output()
 ```
@@ -37,4 +41,4 @@ clip.set_output()
     - `znedi3`, it may be faster than nnedi3
     - `nnedi3cl`, it can be used with new options `device` (same as the parameter of the plugin with the same name)
 2. Chage how to import core because `get_core` is deprecated.
-3. Remove `YCOCG` and `COMPAT`, these will be deprecated in API4.
+3. Remove `YCOCG` and `COMPAT`, deprecated in VapourSynth API4.