README.md in frontkick-0.0.2 vs README.md in frontkick-0.0.3
- old
+ new
@@ -8,9 +8,26 @@
## USAGE
gem install frontkick
+### Basic Usage
+
+ result = Frontkick::Command.exec("echo *")
+ puts result.successful? #=> true if exit_code is 0
+ puts result.stdout #=> stdout output of the command
+ puts result.stderr #=> stderr output of the command
+ puts result.exit_code #=> exit_code of the command
+ puts result.duration #=> the time used to execute the command
+
+### Escape Command
+
+ result = Frontkick::Command.exec(["echo", "*"]) #=> echo the asterisk character
+
+### Timeout Option
+
+ Frontkick::Command.exec("sleep 2 && ls /hoge", :timeout => 1)
+
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)