diff --git a/README.md b/README.md index 537fdaa..d8072f9 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,35 @@ WarcBase ======== -A web archive browser built on HBase +A web archive browser built on HBase. Getting Started --------------- Once you check out the repo, build WarcBase: ``` mvn clean package appassembler:assemble ``` Ingesting WARC files: ``` $ setenv CLASSPATH_PREFIX "/etc/hbase/conf/" -$ sh target/appassembler/bin/IngestWarcFiles \ - -dir /path/to/warc/ -name archive_name -create +$ sh target/appassembler/bin/IngestWarcFiles -dir /path/to/warc/ -name archive_name -create ``` Command-line options: + Use the `-dir` option to specify directory containing WARC files. + Use the `-name` option to specify the name of the archive (will correspond to the HBase table name). + Use the `-create` option to create a new table (and drop the existing table if a table with the same name exists already). Alternatively, use `-append` to add to an existing table. Starting the browser: ``` $ setenv CLASSPATH_PREFIX "/etc/hbase/conf/" -$ sh target/appassembler/bin/WarcBrowser -port 9191 \ - -server http://myhost:9191/ -name archive_name +$ sh target/appassembler/bin/WarcBrowser -port 9191 -server http://myhost:9191/ ``` +Navigate to `http://myhost:9191/` to browse the archive. \ No newline at end of file