README in web-facter-0.0.1 vs README in web-facter-0.0.3
- old
+ new
@@ -1,5 +1,27 @@
A tiny ruby rack application which exposes the data from facter as JSON over HTTP.
gem install web-facter
-Currently this is pretty raw. I plan on making it a little more configurable shortly at which point I'll write a proper README.
+Provides a simple command line tool which runs a built in web server. On accessing
+the specified port you should get a JSON response containing the current facts.
+
+ web-facter --help
+ Usage: web-facter [options] ...
+
+ Configuration options:
+ --no-daemonize Don't daemonize the web server process
+ -p, --port PORT The port to run web-facter on
+ -c, --config FILE The file to load with configuration options
+ -h, --help Display this screenp
+
+
+You can configure web-facter using a configuration file, using the following format, and
+specifying the filename with the --config option above.
+
+ username=gilbert
+ password=george
+ port=3009
+ daemonize=true
+
+Note that the port and daemonize options will override those on the command line.
+The username and password options enable HTTP basic authentication using those details.