README.md in stackprof-webnav-0.0.2 vs README.md in stackprof-webnav-0.0.3

- old
+ new

@@ -17,21 +17,22 @@ ### Install the gem ```bash $ gem install stackprof-webnav ``` -### Pass a dump to it +### Pass a dump/URI to it ```bash -$ stackprof-webnav /path/to/stackprof.dump -$ stackprof-webnav http://path/to/stackprof.dump +$ stackprof-webnav -f /path/to/stackprof.dump +$ stackprof-webnav -u http://path/to/stackprof.dump +$ stackprof-webnav -b http://amazon/s3/bucketlisting.xml ``` -If the argument passed does not exist locally, it is assumed to be a URI and is treated as such. See [stackprof gem][create-dump] homepage to learn how to create dumps. +See [amazon s3 API docs][list-bucket-contents] to see the URI format for S3 bucket listings. ### Profit -Open the browser at localhost:9292 +Open the browser at localhost:9292. If you've used the -f or -u form, you can navigate the dump. If you've used the -b form, you'll see a listing of the keys in the bucket -- click on one that is a dump to browse through it. ## Caveats - no tests, this gem was created for my personal usage in a hack stream, bugs may occur @@ -45,5 +46,6 @@ [create-dump]: https://github.com/tmm1/stackprof#getting-started [main-screenshot]: https://github.com/alisnic/stackprof-webnav/blob/master/screenshots/main.png?raw=true [method-screenshot]: https://github.com/alisnic/stackprof-webnav/blob/master/screenshots/method.png?raw=true [file-screenshot]: https://github.com/alisnic/stackprof-webnav/blob/master/screenshots/file.png?raw=true +[list-bucket-contents]: http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGET.html