aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
index 9527871..dd3d65b 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,19 @@
# fileshow
A menubar-applet for quick hide/show of hidden files in OS X
+
+## Requirements
+ - Tested with OS X El Capitan
+
+## Installation
+ Download the latest dmg-file in the release-folder. Double-click it and drag `fileShow.app` into your applications-folder.
+ As soon as you start the program you should see a little eye in the menubar. Click it to toggle visibility of hidden files.
+
+## Info
+At the moment there is no way to exit the application other than killing the process, rebooting your computer or stopping it in some other way.
+
+## contributions
+All code is stored in a file called `App-Delegate.swift`. Feel free to commit!
+
+## Todo
+ - Add a menu
+ - Add exit-function