瀏覽代碼

Adding basic instructions to README

bodicsek 5 年之前
父節點
當前提交
81e8f0aa96
共有 1 個文件被更改,包括 17 次插入1 次删除
  1. 17 1
      README.md

+ 17 - 1
README.md

@@ -1,3 +1,19 @@
 # canary-log-viewer
 
-Structured log viwer for canary logs
+Structured log viewer for canary logs.
+
+## How to run
+
++ Install [deno](https://deno.land/manual/getting_started/installation)
++ Run `deno run --allow-read clv.ts <logfile>`.
+
+## How to deploy
+
++ Install [OCI CLI](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/cliconcepts.htm)
++ Modify the OCI object storage details in `deploy.sh`.
++ Run `deploy.sh`
+
+## How to install
+
++ Add `clv.sh` to your `PATH` if you are using bash  
+Note: it is using a preauthenticated url of the deployed `clv.ts`.