better readme

.github/workflows/release.yml

@@ -1,4 +1,4 @@
-name: Build and Release ISOs
+name: Release CI
 
 on:
   push:

.github/workflows/test.yml

@@ -0,0 +1,17 @@
+name: Test CI
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Check out the repository
+      uses: actions/checkout@v4
+
+    - name: Install Nix
+      uses: DeterminateSystems/nix-installer-action@main
+
+    - name: Build the flake
+      run: nix build .#nixosConfigurations.installer.config.system.build.isoImage

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 kolyma-labs
+Copyright (c) 2024 Kolyma Labs
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,2 +1,42 @@
-# installer
- | Custom NixOS installer builds for faster initialization
+<p align="center">
+    <img src=".github/assets/header.png" alt="Kolyma's {Installer}">
+</p>
+
+<p align="center">
+    <h3 align="center">NixOS images created with Kolyma's specifications.</h3>
+</p>
+
+<p align="center">
+    <img align="center" src="https://img.shields.io/github/languages/top/orzklv/nix?style=flat&logo=nixos&logoColor=ffffff&labelColor=242424&color=242424" alt="Top Used Language">
+    <a href="https://github.com/orzklv/nix/actions/workflows/test.yml"><img align="center" src="https://img.shields.io/github/v/release/kolyma-labs/installer?style=flat&logo=github&logoColor=ffffff&labelColor=242424&color=242424" alt="Release"></a>
+    <a href="https://github.com/orzklv/nix/actions/workflows/test.yml"><img align="center" src="https://img.shields.io/github/actions/workflow/status/orzklv/nix/test.yml?style=flat&logo=github&logoColor=ffffff&labelColor=242424&color=242424" alt="Test CI"></a>
+</p>
+
+# About
+
+When bootstrapping NixOS on a new server machine, using nixos-anywhere itself becomes a bit of a hassle. This repository aims to provide a simple way to create NixOS images with Kolyma's specifications whereas you may write images to attached usb sticks which will later be booted first upon failed main system boot.
+
+## Features
+
+- Minimal NixOS installation
+- Ready ssh & root password
+
+## Download
+
+You can download the latest release from the [releases page](https://github.com/kolyma-labs/installer/releases).
+
+## Burning the image
+
+If you have physical access to your server machine, just use etcher. If you are using a remote server, you can use `dd` to write the image to a usb stick:
+
+```bash
+dd if=\<image\> of=/dev/sdX bs=4M status=progress oflag=sync
+```
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](license) file for details.
+
+<p align="center">
+    <img src=".github/assets/footer.png" alt="Kolyma's {Installer}">
+</p>