From 9320defc4b8f381e5b7887d212d8d2babc41f2f2 Mon Sep 17 00:00:00 2001
From: Adam Stephens <adam@valkor.net>
Date: Mon, 22 Jan 2024 12:48:47 -0500
Subject: [PATCH] add: readme

---
 README.md | 40 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..185a0a7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,40 @@
+# nixos x13s
+
+This repository aims to provide easy, shared, support for Lenovo X13s on Linux.
+
+The support for this machine is constantly improving in mainline kernel and upstream packages. Eventually the goal is that this repository is no longer necessary.
+
+## Add with a flake
+
+```nix
+{
+  inputs = {
+    nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
+    nixos-x13s.url = "git+https://codeberg.org/adamcstephens/nixos-x13s";
+  };
+
+  outputs =
+    { ... }@inputs:
+    {
+      nixosConfigurations.example = inputs.nixpkgs.lib.nixosSystem {
+        system = "aarch64-linux";
+        modules = [
+          inputs.nixos-x13s.nixosModules.default
+          {
+            nixos-x13s.enable = true;
+
+            # allow unfree firmware
+            nixpkgs.config.allowUnfree = true;
+
+            # define your fileSystems
+            fileSystems."/".device = "/dev/notreal";
+          }
+        ];
+      };
+    };
+}
+```
+
+## Add using not a flake
+
+Not documented, but feel free to submit a PR.