Update README.md

This commit is contained in:
JY Tan
2025-12-23 18:54:01 -08:00
parent 8db245f56e
commit dcdfff1fde

View File

@@ -17,13 +17,23 @@ Fence wraps commands in a sandbox that blocks network access by default and rest
You can use Fence as a Go package or CLI tool.
## Documentation
- [Documentation index](docs/)
- [Security model](docs/security-model.md)
- [Architecture](ARCHITECTURE.md)
- [Examples](examples/)
## Installation
At the moment, we only support MacOS and Linux. For Windows users, we recommend using WSL.
```bash
go install github.com/Use-Tusk/fence/cmd/fence@latest
```
Or build from source:
<details>
<summary>Build from source</summary>
```bash
git clone https://github.com/Use-Tusk/fence
@@ -31,6 +41,13 @@ cd fence
go build -o fence ./cmd/fence
```
</details>
**Additional requirements for Linux:**
- `bubblewrap` (for sandboxing)
- `socat` (for network bridging)
## Quick Start
```bash
@@ -130,27 +147,6 @@ func main() {
}
```
## Documentation
- [Documentation index](docs/)
- [Security model](docs/security-model.md)
- [Architecture](ARCHITECTURE.md)
- [Examples](examples/)
For detailed security model, limitations, and architecture, see [ARCHITECTURE.md](ARCHITECTURE.md).
## Requirements
### macOS
- macOS 10.12+ (uses `sandbox-exec`)
- No additional dependencies
### Linux
- `bubblewrap` (for sandboxing)
- `socat` (for network bridging)
## Attribution
Portions of this project are derived from Anthropic's [sandbox-runtime](https://github.com/anthropic-experimental/sandbox-runtime) (Apache-2.0). This repository contains modifications and additional original work.