aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorOphestra <cat@gensokyo.uk>2025-06-25 21:11:11 +0900
committerOphestra <cat@gensokyo.uk>2025-06-25 21:11:11 +0900
commit0e957cc9c1578ec5c2dd56b664c6731e9d032921 (patch)
tree766e5c519be95ff933021db9bdad499f6fafa7f4 /README.md
parentaa454b158f3713b2ee47162837dcea1efdce0ee6 (diff)
release: 0.0.2
Signed-off-by: Ophestra <cat@gensokyo.uk>
Diffstat (limited to 'README.md')
-rw-r--r--README.md41
1 files changed, 16 insertions, 25 deletions
diff --git a/README.md b/README.md
index 453d851d..86a59f84 100644
--- a/README.md
+++ b/README.md
@@ -1,38 +1,29 @@
-Hakurei
-=======
+<p align="center">
+ <a href="https://git.gensokyo.uk/security/hakurei">
+ <picture>
+ <img src="https://basement.gensokyo.uk/images/yukari1.png" width="200px" alt="Yukari">
+ </picture>
+ </a>
+</p>
-[![Go Reference](https://pkg.go.dev/badge/git.gensokyo.uk/security/hakurei.svg)](https://pkg.go.dev/git.gensokyo.uk/security/hakurei)
-[![Go Report Card](https://goreportcard.com/badge/git.gensokyo.uk/security/hakurei)](https://goreportcard.com/report/git.gensokyo.uk/security/hakurei)
+<p align="center">
+ <a href="https://pkg.go.dev/git.gensokyo.uk/security/hakurei"><img src="https://pkg.go.dev/badge/git.gensokyo.uk/security/hakurei.svg" alt="Go Reference" /></a>
+ <a href="https://goreportcard.com/report/git.gensokyo.uk/security/hakurei"><img src="https://goreportcard.com/badge/git.gensokyo.uk/security/hakurei" alt="Go Report Card" /></a>
+</p>
-Lets you run graphical applications as dedicated subordinate users in a container environment with a nice NixOS
-module to configure target users and provide launch scripts and desktop files.
+Hakurei is a tool for running sandboxed graphical applications as dedicated subordinate users on the Linux kernel.
+It also implements [planterette (WIP)](cmd/planterette), a self-contained Android-like package manager with modern security features.
-Why would you want this?
+## NixOS Module usage
-- It protects the desktop environment from applications.
-
-- It protects applications from each other.
-
-- It provides UID isolation on top of the standard application sandbox.
-
-If you have a flakes-enabled nix environment, you can try out the tool by running:
-
-```shell
-nix run git+https://git.gensokyo.uk/security/hakurei -- help
-```
-
-## Module usage
-
-The NixOS module currently requires home-manager to configure subordinate users.
-
-Full module documentation can be found [here](options.md).
+The NixOS module currently requires home-manager to configure subordinate users. Full module documentation can be found [here](options.md).
To use the module, import it into your configuration with
```nix
{
inputs = {
- nixpkgs.url = "github:NixOS/nixpkgs/nixos-24.05";
+ nixpkgs.url = "github:NixOS/nixpkgs/nixos-24.11";
hakurei = {
url = "git+https://git.gensokyo.uk/security/hakurei";