From a794bfdb8a40ea4f7c8a5597f805de517d808cd9 Mon Sep 17 00:00:00 2001 From: marshmallow Date: Sun, 22 Jun 2025 17:25:36 +1000 Subject: [PATCH] reframe the goal of the project --- README.md | 2 +- doc/guide/wire.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7e5490b..b117834 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ ![Build Status](https://img.shields.io/github/actions/workflow/status/wires-org/wire/build.yml?branch=main&style=flat-square&label=Builds) ![Documentation Status](https://img.shields.io/github/actions/workflow/status/wires-org/wire/pages.yml?branch=main&style=flat-square&label=Documentation) -wire is a tool to deploy nixos systems. its configuration is a superset of colmena however it is not a fork. +wire is a tool to deploy nixos systems. its usage is inspired by colmena however it is not a fork. Read the [The Guide](https://wire.althaea.zone/guide/wire.html), or continue reading this readme for development information. diff --git a/doc/guide/wire.md b/doc/guide/wire.md index 76b3518..daa3374 100644 --- a/doc/guide/wire.md +++ b/doc/guide/wire.md @@ -18,9 +18,9 @@ comment: true

-Wire is a tool to deploy NixOS systems. Its configuration is a superset[^1] of [colmena](https://colmena.cli.rs/), however it is **not** a fork. +Wire is a tool to deploy NixOS systems. Its usage is inspired by [colmena](https://colmena.cli.rs/). In many places it's configuration attempts to remain a superset[^1] of colmena, however it is **not** a fork. -[^1]: Any colmena configuration will continue to work with wire, but wire has additional ergonomic changes you can take advantage of. +[^1]: A lot of your colmena module options will continue to work with wire, but wire has additional ergonomic changes you can take advantage of. ::: warning Wire is alpha software, please use at your own risk. Many features listed in this documentation may not be complete / implemented. -- knotmirror 0.0.1