From 26f5e1863fff58c465507326f3a3255088bd72d7 Mon Sep 17 00:00:00 2001 From: Andinus Date: Wed, 15 Apr 2020 20:23:20 +0530 Subject: Explain why user should use lynx in readme --- README.org | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.org b/README.org index 766769f..a6b430a 100644 --- a/README.org +++ b/README.org @@ -12,6 +12,16 @@ currently only /OpenBSD/ is supported. | Source Code | [[https://tildegit.org/andinus/lynx][Andinus / Lynx]] | | GitHub (Mirror) | [[https://github.com/andinus/lynx][Lynx - GitHub]] | +* Why use lynx? +- *UnveilPaths* & *UnveilCommands*: /unix/ package provides simple Unveil syscalls so + this is useful because you don't have to write these functions yourself + manually in every project. + +- /lynx/ manages build flags for you, which means that /lynx/ will return nil on + unsupported systems whereas you have handle that yourself in /unix/ package. + +*Note*: Unveil, UnveilPaths & UnveilCommands ignore some errors, look at examples +before using them. * Examples ** UnveilPaths / UnveilPathsStrict UnveilPaths takes a map of path, permission & unveils them one by one, it will -- cgit 1.4.1-2-gfad0