diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..ebab937f2ed7a81cd592e813aa33a8d6e918be10 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +ta-tool - the swiss knife for the technical analyst working with Rosetta Achival Information system +=================================================================================================== + +== Installation + +You could use Distzilla to install the tool locally. See command 'dist' for details. + +Alternatively, copy the 'bin/' and 'lib' paths to our local perl installation. + +== Usage + + ta-tool <cmd> [options] + + COMMANDS: + search the search + count + + OPTIONS: + -v --verbose Show more detailed option + -h --help Prints this help information + +at the moment only the commands 'search' and 'count' supported, but will be extended in near future.