README.md in ferver-1.2.1 vs README.md in ferver-1.3.0
- old
+ new
@@ -15,10 +15,11 @@
Here's the spec for **ferver**:
* available over http
* provide a list of files as html and json
* ignore directories
+* ignore dotfiles - turn off with setting
* serve files as individual files
* minimal config
* able to specify the directory to serve files from
### Getting started
@@ -39,19 +40,29 @@
$ ferver
````
##### Use a specific directory
-For exmple, to serve files from **/Users/rob/Projects/ferver/** directory pass the path in as below;
+For exmple, to serve files from **/Users/rob/Projects/ferver/** directory pass the path in as below using the `--directory` option.
```bash
$ ferver -d /Users/rob/Projects/ferver/
````
+##### Serve all files
+
+By default, dotfiles will be hidden. Use the `--all` option to serve all files.
+
+```bash
+$ ferver -a
+````
+
+> Note that zero size files will always be hidden.
+
##### Command line help
-For a list of arguments just use the `-h` switch.
+For a list of arguments just use the `--help` switch.
```bash
$ ferver -h
````
@@ -65,11 +76,11 @@
`http://localhost:4567/files`
#### JSON
-Requesting content-type `json`, for exampled passing the header `Accept: application/json` will return the list of files as json.
+Requesting content-type `json`, for example passing the header `Accept: application/json` will return the list of files as json.
```bash
curl -i -H "Accept: application/json" http://localhost:4567/files
```
@@ -81,18 +92,11 @@
### Contributions
Please use the GitHub pull-request mechanism to submit contributions.
-After cloning the repo, you can run the web application without having to install the gem package by running a Rake task named `server`, or it's alias `s`.
+After cloning the repo, you can run the web application without having to publish and then install the gem package by calling the executable as per normal.
-```bash
-$ rake s
-
-# or
-
-$ rake s /path/to/dir
-```
### License
This project is available for use under the MIT software license.
See LICENSE