From 853e98f37bd94e592e27e15c69c6bbc15685245e Mon Sep 17 00:00:00 2001 From: Alvin Rizki Date: Fri, 23 Dec 2022 18:28:39 +0700 Subject: [PATCH] docs: update readme --- README.md | 40 +++++++++++++++++++++++++++++++++++++++- 1 file changed, 39 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6ecd7b3..ec6af1e 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,43 @@ # ntfs-wr -Simple CLI to mount and enable write on NTFS file system easily on MacOS +Simple CLI to mount and enable write on NTFS file system easily on MacOS. + +Tested on: +1. Macbook Pro 14", M1 Pro, 16GB ram, MacOS Monterey 12.6.1 + +## Requirements + +## Installation + +```bash +$ go install github.com/cikupin/ntfs-wr +``` + +## Usage + +1. See list of commands + ```bash + $ ntfs-wr --help + ``` + +2. List external drive with NTFS file system + ```bash + $ ntfs-wr list + ``` + +3. Mount external NTFS partition (you need to run as root) + ```bash + $ sudo ntfs-wr mount + ``` + +4. Open NTFS mounted volume. You must do copy-paste on this directory. + ```bash + $ ntfs-wr open + ``` + +4. Unmount mounted volume (you need to run as root) + ```bash + $ sudo ntfs-wr unmount + ``` ## To do plan