Skip to content

Commit

Permalink
docs for building and version info
Browse files Browse the repository at this point in the history
  • Loading branch information
mmcquillan committed Jan 8, 2018
1 parent 0af5ded commit 3bdddd6
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 3 deletions.
5 changes: 5 additions & 0 deletions BUILD.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Build steps

```
go install -ldflags "-X main.version=XXX" github.com/mmcquillan/lawsg
```
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# lawsg - The AWS Cloudwatch Logs Viewer

Why another cloudwatch CLI?
### Why another cloudwatch CLI?
- Advanced formatting to help you find what you need
- Highlight keywords in Green, Yellow or Red to capture your attention
- Display preferences via command line flags, env variables or a config file
- Help for when you can't quite remember the group name


Get Started:
### Get Started
1. Install on Mac via brew: `brew install mmcquillan/tools/lawsg`
2. Alternatively compile via go: `go get github.com/mmcquillan/lawsg`
3. Ensure you set your AWS Environment Variables:
Expand All @@ -18,6 +18,15 @@ Get Started:
5. Enjoy all your wonderful logs!


How to Use:
### How to Use
[Detailed Help](HELP.md)


### Releases

v0.1.1
- Added the multi-line formatting option to handle multiple log entries per Event Message
- Fixed a help issue

v0.1.0
- Initial release

0 comments on commit 3bdddd6

Please sign in to comment.