README.md in shell2html-0.0.4 vs README.md in shell2html-0.0.5
- old
+ new
@@ -7,13 +7,13 @@
[](https://gemnasium.com/mose/shell2html)
[](https://codeclimate.com/github/mose/shell2html)
----
-A ruby lib for conversion between bash colors and HTML.
+A ruby lib for conversion between bash colors and HTML. It was created to help the Shellplay tool to export html from colored shell output.
-Code is still experimental, use at your own risk.
+Code is still experimental, use at your own risk. But "it works for me".
Installation
-------------------
Add this line to your application's Gemfile:
@@ -28,17 +28,28 @@
$ gem install shell2html
Usage
-----------------
+````
+require "shell2html"
+
+puts Shell2html.to_html("\e[33m>\e[0m\e[1;31m some colored thing.\e[0m")
+````
+
Commandline command
-------------------
+
+(not functionnal yet)
+
There is a command `shell2html` provided in this lib for commandline execution.
shell2html <file>
echo "\e[31mPrompt: \e[0m" | shell2html
The html is output in stdout.
+
+An example of usage is visible on http://mose.com/20140814-dokku/
Contributing
-----------------
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)