Replace README with a manpage

2 files changed, 54 insertions, 21 deletions

diff --git a/README b/README
deleted file mode 100644
index a45fabb..0000000
--- a/README
+++ /dev/null
@@ -1,21 +0,0 @@
-libhttpc
-<======>
-HTTP Library (Cute :3)
-
-This library provides some QoL functions for parsing requests and constructing
-responses.
-
-Notice that libhttpc doesn't do any validation, validate data yourself or use
-reverse proxy for this task.
-
-Using
-<===>
-All the documentation is stored in the single header file. You can try to use
-doxygen or smth kinda to generate docs from it ig.
-
-This is the way how in my opinion this library should be used:
-1. Receive request from the user
-2. Pass this request to the LibHTTPC_loadRequest function
-3. Handle the request
-4. Generate response using LibHTTPC_dumpResponse function
-5. Send generated response
diff --git a/README.7 b/README.7
new file mode 100644
index 0000000..e577e0a
--- /dev/null
+++ b/README.7
@@ -0,0 +1,54 @@
+.Dd December 13, 2024
+.Dt LIBHTTPC 7
+.Os
+.
+.Sh NAME
+.Nm libhttpc
+.Nd HTTP Library (Cute :3)
+.
+.Sh DESCRIPTION
+This library provides
+some QoL function
+for parsing requests
+and constructing responses.
+It's written
+for making
+HTTP servers.
+.
+.Pp
+If you want to
+check the documentation,
+you may want to
+check
+.Pa include/libhttpc.h
+file
+or
+.Xr libhttpc 3
+.
+.Sh EXAMPLES
+As an example,
+I can
+tell you
+the way
+how personally I
+use this library:
+.Bl -bullet
+.It
+Receive request from the user
+.It
+Pass the request to the
+.Xr libhttpc_loadrequest 3
+function
+.It
+Handle the request
+.It
+Send request back
+using
+.Xr libhttpc_dumpresponse 3
+.El
+.
+.Sh SEE ALSO
+.Xr libhttpc 3
+.
+.Sh AUTHORS
+.An Nakidai Perumenei Aq Mt nakidai@disroot.org