doc: update README

chiichen · Nov 30, 2024 · 7f4e4e1 · 7f4e4e1
1 parent 1d40980
commit 7f4e4e1
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 7 deletions.
diff --git a/libvnc-sys/README.md b/libvnc-sys/README.md
@@ -2,14 +2,14 @@
 
 ## What's this
 
-The raw bindings of [libvncserver](https://github.com/LibVNC/libvncserver) generated by `bindgen` automatically. Supports building from pkg-config (default) and source code (planned implementation)
+The raw bindings of [libvncserver](https://github.com/LibVNC/libvncserver) generated by `bindgen` automatically. Supports building from pkg-config and source code (default)
 
 ## Quick Start
 
-### Install libvncserver package
+### Install libvncserver package (Optional)
 
 - Ubuntu
-```bash 
+```bash
 sudo apt-get install libvncserver-dev
 ```
 

diff --git a/libvnc/README.md b/libvnc/README.md
@@ -2,16 +2,16 @@
 
 ## What's this
 
-[libvncserver](https://github.com/LibVNC/libvncserver) safe bindings for Rust. Although its name is libvncserver, it actually provides both server and client functions
+Higher level safe bindings of [libvncserver](https://github.com/LibVNC/libvncserver) for Rust. Although its name is libvncserver, it actually provides both server and client
 
 ## Quick Start
 
-`Build from source` is not implemented yet, so we need to install the pre-built libvncserver package.
+We build libvncserver from source as default. If you want to use prebuilt package, you can install it by following the instructions below and enable feature `pkg`.
 
-### Install libvncserver package
+### Install libvncserver package (Optional)
 
 - Ubuntu
-```bash 
+```bash
 sudo apt-get install libvncserver-dev
 ```