From fc1d495d980e2717c87255495ba8ab63df9361a5 Mon Sep 17 00:00:00 2001
From: mii443 <39086319+mii443@users.noreply.github.com>
Date: Tue, 3 Jun 2025 20:40:10 +0900
Subject: [PATCH] Create README.md

---
 README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..891f059
--- /dev/null
+++ b/README.md
@@ -0,0 +1,45 @@
+# Izoli
+
+A lightweight Linux container/sandbox implementation written in Rust.
+
+## What is Izoli?
+
+Izoli creates isolated execution environments using Linux namespaces and cgroups v2. It's designed for process sandboxing and resource management.
+
+## Features
+
+- Process isolation (PID, UTS, IPC, Mount namespaces)
+- Resource limits (CPU, memory, process count)
+- Filesystem isolation with chroot
+- Optional network isolation
+
+## Requirements
+
+- Linux with cgroups v2 support
+- Root privileges
+- Rust 1.70+ (for building)
+
+## Installation
+
+```bash
+git clone <repository-url>
+cd izoli
+cargo build --release
+```
+
+## Usage
+
+### CLI
+```bash
+sudo ./target/release/izoli
+```
+
+This creates an isolated bash shell with:
+- 1GB memory limit
+- CPU limited to one core
+- Maximum 10 processes
+- Read-only access to system directories
+
+## License
+
+MIT License - see [LICENSE](LICENSE) file.