Merge pull request #22 from jakewilliami/update-readme

Update README to mention behavioural caveats
jakewilliami · Sep 27, 2022 · 2d4a64e · 2d4a64e
2 parents c06777b + dd47013
commit 2d4a64e
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -6,14 +6,17 @@
 [![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle)
 
 
-A simple tool to determine if a file directory is hidden.  Works on any&trade; file system!
+A simple tool to determine if a file directory is hidden.  Works on any&trade; OS and file system!
+
+This library exports one function: `ishidden`.  Typically, a file or directory is classified as "hidden" if is it hidden from a normal directory listing.  See [the documentation](https://jakewilliami.github.io/HiddenFiles.jl/dev) for notes on the behaviour of `ishidden`.
 
 ## Quick Start
 
 ```julia
 julia> using HiddenFiles
 
 julia> is_hidden("$(homedir())/.bashrc")
+true
 ```
 
 ## History