aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..444c9e5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# arfnet2-status
+
+ARFNET Fast file index and search
+
+## Description
+
+ - C webapp
+ - libmicrohttpd
+ - POSIX regex
+
+## Features
+
+ - All cached indexed in memory
+ - Landing page w roots and searchbox
+ - File directory tree browsing
+ - Metadata (mime type, size)
+ - Icons
+ - Sorting
+ - Searching
+ - Advanced name substring, exact, regex
+ - Sorting
+
+## Building
+
+Depends on libmicrohttpd
+
+```
+make
+```
+