From 09655e33b091cab3fa059d4194ba28e54d1cf719 Mon Sep 17 00:00:00 2001 From: ray-1337 <33544674+ray-1337@users.noreply.github.com> Date: Sat, 3 Jun 2023 01:02:40 +0200 Subject: [PATCH] update README.md sentences --- README.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index f395fa2..74e69d2 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,10 @@ # Node UFW -Manipulate UFW (Linux distribution only, works best on Ubuntu) via Node.js. -> This module is under development. Use with caution. +Manipulate UFW (Linux distribution only) through Node.js. ## System Requirements -Only supported on [Node.js](https://nodejs.org) version 14 or above, and Ubuntu version 18 or above. +The module only supports [Node.js](https://nodejs.org) up to version 16, and Ubuntu version 18 or above. -This also requires **root** access, or else you'll get an error from ufw itself/password prompt from Ubuntu. +This also requires **root** access, otherwise you will get an error from `ufw` itself, asking you a password with prompt. ## Installation ```shell @@ -14,7 +13,6 @@ $ pnpm add node-ufw ``` ## Usage - ```js const nodeUfw = require("node-ufw").default; // JavaScript import nodeUfw from "node-ufw"; // TypeScript