-
Notifications
You must be signed in to change notification settings - Fork 133
Description
I just jumped here, and the first thing I wanted to know was NOT how-to download or install NBD which the README gives.
No the first thing that I want to know was What is NBD and what is it used for!
A single paragraph is generally more than enough. Though a link to some longer introduction would be better.
Not everyone coming to a project, knows what a project is, or what it is used for!
It has become a common problem on the internet where everyone assumes if you are jumping to it they already know what it is.
For example add this as first item in README...
A Network Block Device (NBD) is a Linux protocol and technology that lets a computer access a remote storage device (like a hard drive or partition) as if it were a local, physical disk, using a simple client-server model over a TCP/IP network, enabling remote booting, swapping, or filesystem access without complex network file systems like NFS. It works by exporting a block device from a server and presenting it as a local block device on a client machine, allowing standard block-level operations (read/write) over the network.