Explain why user should use lynx in readme

This commit is contained in:
Andinus 2020-04-15 20:23:20 +05:30
parent 55b538e87c
commit 26f5e1863f
Signed by: andinus
GPG Key ID: B67D55D482A799FD
1 changed files with 10 additions and 0 deletions

View File

@ -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