commit 21bc931

update docs, update README (see desc.)

docs now mention -v flag
REAME now has correct paths to manpages (bruh)

.

 1@@ -7,13 +7,29 @@ A simple home media server for UNIX systems.
 2 ```sh
 3 make build # or debug
 4 cp parados.conf /etc/
 5+# ./parados -v
 6 ./parados
 7 ```
 8 
 9 ### Documentation
10 All documentation can be found in [docs/](docs/)
11+```sh
12+man 1 parados       # Parados server usage
13+man 7 parados       # Interfacing with parados
14+man 5 parados.conf  # Parados configuration
15 ```
16-man parados      # parados(1)
17-man parados-dev  # parados(7)
18-```
19+
20+### Issues
21+If you find a bug or would like to suggest something,
22+open an issue on the GitHub page. Issues should be
23+detailed and give steps on replicating the issue if
24+possible.
25+
26+### Contributions
27+If you wish to contribute, create a PR with details
28+on what is being changed, added or removed. **The code
29+style (indentation, variable names, formatting) should
30+_not_ be altered.** Please make sure you know how the
31+formatting of the project looks like before submitting
32+a PR.  
33 

  1@@ -3,24 +3,29 @@
  2 .Os
  3 .Sh NAME
  4 .Nm parados
  5-.Nd simple (HTTP) media server
  6+.Nd simple HTTP media server
  7 .Sh SYNOPSIS
  8 .Nm parados
  9+.Op Fl v
 10 .Sh DESCRIPTION
 11 .Nm
 12-is a minimal (HTTP) media server used to serve local audio and video
 13-files over a network.
 14-It provides a small and stable interface designed to be used by
 15-external clients such as media players or web frontend interfaces.
 16+is a minimal HTTP media server for serving local audio and video files
 17+over a network.
 18+It exposes a HTTP interface intended for use by external
 19+clients such as media players or web frontends.
 20 .Pp
 21 The server scans a directory tree at startup and exposes the contents
 22-through its simple HTTP API.
 23-Each file is assigned a hashed identifier derived from its relative
 24-path.
 25+through a simple HTTP API.
 26+Each file is assigned an identifier derived from its relative path.
 27 .Pp
 28 .Nm
 29-does not provide a graphical interface.
 30-All user interaction is expected to occur through clients.
 31+does not provide a user interface;
 32+all interaction is expected to happen through clients.
 33+.Sh OPTIONS
 34+.Bl -tag -width Ds
 35+.It Fl v
 36+Print version information and exit.
 37+.El
 38 .Sh OPERATION
 39 On startup,
 40 .Nm
 41@@ -28,57 +33,48 @@ performs the following steps:
 42 .Bl -enum -compact
 43 .It
 44 Load configuration from
 45-.Pa /etc/parados.conf,
 46-or 
 47-.Pa ./parados.conf
 48-if the system-wide file is not present.
 49+.Pa /etc/parados.conf
 50+or, if not present,
 51+.Pa ./parados.conf .
 52+.It
 53+Parse user and access rules.
 54 .It
 55-Scan the configured media directory and build a library.
 56+Scan the configured media directory and build the media library.
 57 .It
 58 Bind to the configured address and port.
 59 .It
 60-Accept HTTP connections and serve requests.
 61+Accept and handle HTTP requests.
 62 .El
 63 .Pp
 64 Each incoming connection is handled independently.
 65-The server is designed for minimising complexity as opposed to concurrency.
 66-.Sh HTTP INTERFACE
 67-The following endpoints are provided:
 68-.Bl -tag -width Ds
 69-.It Pa /ping
 70-Return a plain text response to indicate that the server is running.
 71-.It Pa /library
 72-Return a JSON document describing the media library.
 73-.It Pa /meta/<id>
 74-Return metadata for a single media item.
 75-.It Pa /stream/<id>
 76-Stream the raw contents of a media file.
 77-Byte range requests are supported.
 78-.It Pa /queue
 79-Return an M3U playlist containing all accessible media items.
 80-.El
 81+Connections are closed after each request.
 82+.Sh LOGGING
 83+.Nm
 84+writes diagnostic and status messages to standard error.
 85 .Pp
 86-Authentication may be required depending on configuration.
 87+Logging verbosity is controlled by the
 88+.Ic verbose_log
 89+setting in
 90+.Xr parados.conf 5 .
 91+.Sh HTTP INTERFACE
 92+The HTTP interface is documented in
 93+.Xr parados 7 .
 94 .Sh AUTHENTICATION
 95-.Nm
 96-supports HTTP Basic authentication.
 97 Authentication is optional and configured through
 98 .Xr parados.conf 5 .
 99 .Pp
100-If no users are defined, requests are served without authentication.
101-If one or more users are defined, all requests apart from
102-.Pa /ping
103-require valid credentials.
104+If no users are defined, all requests are served without authentication.
105+If one or more users are defined, HTTP Basic authentication is required
106+for all endpoints except
107+.Pa /ping .
108 .Pp
109-Access to files is restricted per user based on configured allow-list.
110-.Sh CONFIGURATION
111-Configuration is read from
112-.Xr parados.conf 5 .
113+Access to media files is restricted per user based on configured
114+allow-lists.
115 .Sh EXIT STATUS
116 .Ex -std
117 .Sh SEE ALSO
118 .Xr parados.conf 5 ,
119-.Xr parados-protocol 7
120+.Xr parados 7
121 .Sh AUTHORS
122 .An Abhinav Prasai
123