README: update

This commit is contained in:
0x1eef 2024-03-07 22:35:34 -03:00
parent 05a5f3c8af
commit 36c091bee6

View file

@ -1,9 +1,9 @@
## About ## About
hbsdctl.rb is a Ruby C extension that binds libhbsdcontrol from the hbsdctl.rb is a C extension that binds libhbsdcontrol from the
[hardenedbsd](https://hardenedbsd.org) project. Through this library, [hardenedbsd](https://hardenedbsd.org) project to Ruby. Through
you can query what features are available and if root, enable or disable this library, you can query what features are available and if
those features for a given file. root, enable or disable those features for a given file.
## Examples ## Examples
@ -34,9 +34,14 @@ The example enables the mprotect feature for the emacs binary:
require 'hbsdctl' require 'hbsdctl'
BSD::Control BSD::Control
.feature!(:mprotect) .feature!(:mprotect)
.enable!("/usr/local/bin/emacs") .enable!("/usr/local/bin/emacs-29.2")
``` ```
## Documentation
A complete API reference is available at
[0x1eef.github.io/x/hbsdctl.rb](https://0x1eef.github.io/x/hbsdctl.rb).
## Install ## Install
**Git** **Git**