Skip to content

Commit 5220637

Browse files
committed
Improve readme
1 parent 4efe5bd commit 5220637

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

readme.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
# comin - GitOps for NixOS Machines
22

3-
**comin** is a deployment tool operating in pull mode. Running on a
4-
machine, it periodically polls Git repositories and deploys the NixOS
5-
configuration associated to the machine.
3+
**comin** is a NixOS deployment tool operating in pull mode. Running
4+
on a machine, it periodically polls Git repositories and deploys the
5+
NixOS configuration associated to the machine.
66

77
## Features
88

9-
- Git push to deploy NixOS configurations
10-
- Support testing branches to try changes
11-
- Poll multiple Git remotes to avoid SPOF
12-
- Support machines migrations
13-
- Fast iterations with local remotes
14-
- Observable thanks to exposed Prometheus metrics
9+
- :snowflake: Git push to deploy NixOS configurations
10+
- :construction: Support testing branches to [try changes](./docs/howtos.md#how-to-test-a-nixos-configuration-change)
11+
- :rocket: Poll [multiple Git remotes](./docs/generated-module-options.md#servicescominremotes) to avoid SPOF
12+
- :postbox: Support [machines migrations](./docs/howtos.md#how-to-migrate-a-configuration-from-a-machine-to-another-one)
13+
- :fast_forward: Fast iterations with [local remotes](./docs/howtos.md#iterate-faster-with-local-repository)
14+
- :satellite: Observable via [Prometheus metrics](./docs/generated-module-options.md#servicescominexporter)
1515

1616
## Quick start
1717

0 commit comments

Comments
 (0)