From af7c43ccba136f92bce6551c25e9c61b9223248e Mon Sep 17 00:00:00 2001
From: Les De Ridder <les@lesderid.net>
Date: Tue, 8 Nov 2016 02:57:35 +0100
Subject: [PATCH] Add readme

---
 README.md  | 18 ++++++++++++
 example.md | 82 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 100 insertions(+)
 create mode 100644 README.md
 create mode 100644 example.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d78e6d6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# dtagfs
+dtagfs is a FUSE file system that mounts a directory with tagged files as a file system tree.
+
+This allows for easy filtering of tagged files (e.g. '/mountpoint/tag1/tag2/' contains all files with tags 'tag1' and 'tag2').
+
+## Example
+See [example.md](example.md).
+
+## Usage
+`usage: dtagfs <source> <mount point> [-f] [-o option[,options...]]`
+
+-f: fork to background
+
+## Supported tag sources
+* Dublin Core (XMP), via [exempi-d](https://github.com/lesderid/exempi-d)
+
+## License
+dtags is released under the [University of Illinois/NCSA license](LICENSE).
diff --git a/example.md b/example.md
new file mode 100644
index 0000000..dd92354
--- /dev/null
+++ b/example.md
@@ -0,0 +1,82 @@
+# dtagfs example
+File 'orange.jpg' with tags 'fruit', 'colour:orange', and 'citrus fruit'.  
+File 'lemon.jpg' with tags 'fruit', 'colour:yellow', and 'citrus fruit'.  
+File 'strawberry.jpg' with tags 'fruit', and 'colour:red'.  
+File 'lemonade.jpg' with tags 'beverage', and 'colour:yellow'.  
+
+Mounting this yields the following file system tree:
+	mountpoint/
+	├── beverage
+	│   ├── colour:yellow
+	│   │   └── lemonade.jpg
+	│   └── lemonade.jpg
+	├── citrus fruit
+	│   ├── colour:orange
+	│   │   ├── fruit
+	│   │   │   └── orange.jpg
+	│   │   └── orange.jpg
+	│   ├── colour:yellow
+	│   │   ├── fruit
+	│   │   │   └── lemon.jpg
+	│   │   └── lemon.jpg
+	│   ├── fruit
+	│   │   ├── colour:orange
+	│   │   │   └── orange.jpg
+	│   │   ├── colour:yellow
+	│   │   │   └── lemon.jpg
+	│   │   ├── lemon.jpg
+	│   │   └── orange.jpg
+	│   ├── lemon.jpg
+	│   └── orange.jpg
+	├── colour:orange
+	│   ├── citrus fruit
+	│   │   ├── fruit
+	│   │   │   └── orange.jpg
+	│   │   └── orange.jpg
+	│   ├── fruit
+	│   │   ├── citrus fruit
+	│   │   │   └── orange.jpg
+	│   │   └── orange.jpg
+	│   └── orange.jpg
+	├── colour:red
+	│   ├── fruit
+	│   │   └── strawberry.jpg
+	│   └── strawberry.jpg
+	├── colour:yellow
+	│   ├── beverage
+	│   │   └── lemonade.jpg
+	│   ├── citrus fruit
+	│   │   ├── fruit
+	│   │   │   └── lemon.jpg
+	│   │   └── lemon.jpg
+	│   ├── fruit
+	│   │   ├── citrus fruit
+	│   │   │   └── lemon.jpg
+	│   │   └── lemon.jpg
+	│   ├── lemonade.jpg
+	│   └── lemon.jpg
+	├── fruit
+	│   ├── citrus fruit
+	│   │   ├── colour:orange
+	│   │   │   └── orange.jpg
+	│   │   ├── colour:yellow
+	│   │   │   └── lemon.jpg
+	│   │   ├── lemon.jpg
+	│   │   └── orange.jpg
+	│   ├── colour:orange
+	│   │   ├── citrus fruit
+	│   │   │   └── orange.jpg
+	│   │   └── orange.jpg
+	│   ├── colour:red
+	│   │   └── strawberry.jpg
+	│   ├── colour:yellow
+	│   │   ├── citrus fruit
+	│   │   │   └── lemon.jpg
+	│   │   └── lemon.jpg
+	│   ├── lemon.jpg
+	│   ├── orange.jpg
+	│   └── strawberry.jpg
+	├── lemonade.jpg
+	├── lemon.jpg
+	├── orange.jpg
+	└── strawberry.jpg