From ee70b18ec6647a4f05b715a9b9ead7276530a136 Mon Sep 17 00:00:00 2001 From: Zhaofeng Li Date: Thu, 18 Nov 2021 16:10:30 -0800 Subject: [PATCH] Post-release manual updates --- README.md | 16 +++++++++++----- manual/src/tutorial/flakes.md | 14 +++++++++++++- manual/src/tutorial/index.md | 7 ++++++- 3 files changed, 30 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 61f775d..d08aa7f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # Colmena -[![Manual](https://img.shields.io/badge/Manual-Unstable-informational)](https://zhaofengli.github.io/colmena/unstable) +[![Stable Manual](https://img.shields.io/badge/Manual-Stable-informational)](https://zhaofengli.github.io/colmena/stable) +[![Unstable Manual](https://img.shields.io/badge/Manual-Unstable-orange)](https://zhaofengli.github.io/colmena/unstable) [![Build](https://github.com/zhaofengli/colmena/workflows/Build/badge.svg)](https://github.com/zhaofengli/colmena/actions/workflows/build.yml) Colmena is a simple, stateless [NixOS](https://nixos.org) deployment tool modeled after [NixOps](https://github.com/NixOS/nixops) and [morph](https://github.com/DBCDK/morph), written in Rust. @@ -24,8 +25,15 @@ $ colmena apply --on @tag-a ## Installation -Colmena doesn't have a stable release yet. -To install the latest development version to the user profile, use the following command: +To install the latest stable version to the user profile, use the following command: + +```bash +nix-env -if https://github.com/zhaofengli/colmena/tarball/stable +``` + +### Unstable Version + +To install the latest development version: ```bash nix-env -if https://github.com/zhaofengli/colmena/tarball/main @@ -37,8 +45,6 @@ Alternatively, if you have a local clone of the repo: nix-env -if default.nix ``` -### Unstable Binary Cache - A public binary cache is available at https://colmena.cachix.org, courtesy of Cachix. This binary cache contains unstable versions of Colmena built by [GitHub Actions](https://github.com/zhaofengli/colmena/actions). diff --git a/manual/src/tutorial/flakes.md b/manual/src/tutorial/flakes.md index 2e88bbf..80c875c 100644 --- a/manual/src/tutorial/flakes.md +++ b/manual/src/tutorial/flakes.md @@ -3,7 +3,19 @@ ## Installation -Colmena doesn't have a stable release yet. +To quickly try Colmena out, use the following command to enter an ephemeral environment with the latest stable version of `colmena`: + +```bash +nix shell github:zhaofengli/colmena/stable +``` + +To install Colmena to the user profile, use the following command: + +```bash +nix-env -if https://github.com/zhaofengli/colmena/tarball/stable +``` + +You can also add `github:zhaofengli/colmena/stable` as an input in your Flake and add the `colmena` package to your `devShell`. If you are interested in trying out the bleeding-edge version of Colmena, Read [the unstable version](https://zhaofengli.github.io/colmena/unstable) of the Manual for instructions. diff --git a/manual/src/tutorial/index.md b/manual/src/tutorial/index.md index a37f151..a94b9c1 100644 --- a/manual/src/tutorial/index.md +++ b/manual/src/tutorial/index.md @@ -3,7 +3,12 @@ ## Installation -Colmena doesn't have a stable release yet. + +To install the latest stable version to the user profile, use the following command: + +```bash +nix-env -if https://github.com/zhaofengli/colmena/tarball/stable +``` If you are interested in trying out the bleeding-edge version of Colmena, Read [the unstable version](https://zhaofengli.github.io/colmena/unstable) of the Manual for instructions.