Create README.md

kkapsner · Mar 24, 2015 · 88a10bd · 88a10bd
1 parent 7877ae9
commit 88a10bd
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,18 @@
+# addNetworkFavorite
+Adds a network share to Finder favorites list
+
+First tries to mount the share and then tries to add the favorite.
+If the share is already mounted the mount path is guessed.
+
+# usage
+```shell
+ddNetworkFavorite SHARE_URL PATH_IN_SHARE (optional) DISPLAY_NAME
+```
+
+# examples
+```shell
+addnetworkFavorite smb://example.org/share ""
+addnetworkFavorite smb://example.org/share "" "display name"
+addnetworkFavorite smb://example.org/share folder/
+addnetworkFavorite smb://example.org/share folder/ "display name"
+```