From 53fa96178a15eaca46adb347bb0e97aa2a4cc894 Mon Sep 17 00:00:00 2001
From: Akira Komamura <akira.komamura@gmail.com>
Date: Fri, 3 Dec 2021 22:44:39 +0900
Subject: [PATCH] docs: Add readme

---
 README.org | 5 +++++
 1 file changed, 5 insertions(+)
 create mode 100644 README.org

diff --git a/README.org b/README.org
new file mode 100644
index 0000000..46c6867
--- /dev/null
+++ b/README.org
@@ -0,0 +1,5 @@
+* nix-org-babel
+This is a quick and dirty implementation of =org-babel-tangle= in Nix.
+It provides a function that takes an Org string and returns the contents of source blocks in a particular language.
+
+[[https://github.com/talyz/fromElisp][talyz/fromElisp]] has a built-in Org support, but I created this because I needed more control on which parts to extract. It provides an option for excluding subtrees matching a particular heading pattern. For example, you can omit archived subtrees from the output.