From cc128ac3290dede669423c2986ac204175559e1b Mon Sep 17 00:00:00 2001
From: robocopAlpha <35454738+robocopAlpha@users.noreply.github.com>
Date: Tue, 4 Aug 2020 15:51:13 +0300
Subject: [PATCH] Squashed commit of the following:

commit 89a3b71e24dcf67c98fc9384d0250256bc871ed2
Author: robocopAlpha <35454738+robocopAlpha@users.noreply.github.com>
Date:   Tue Aug 4 15:50:36 2020 +0300

    update readme

    Improve wording.

commit 34f328de594f4df5e4f40ec1c2f5f148a2abb650
Author: robocopAlpha <35454738+robocopAlpha@users.noreply.github.com>
Date:   Tue Aug 4 13:55:02 2020 +0300

    Update install.sh

    Fix checking if the installation location is writable or not

commit 6296379a5525eb623b2347536c215c6405b2188a
Author: robocopAlpha <35454738+robocopAlpha@users.noreply.github.com>
Date:   Tue Aug 4 13:50:33 2020 +0300

    change order of checking shopt nocasematch

commit 6889284f6b1f0b3cfd0c58bf608e39eda64a250e
Author: robocopAlpha <35454738+robocopAlpha@users.noreply.github.com>
Date:   Tue Aug 4 13:48:20 2020 +0300

    Installs in the same place as homebrew

commit f67e85057547da42b5ea21e3b3c9997ec17a3b41
Author: robocopAlpha <35454738+robocopAlpha@users.noreply.github.com>
Date:   Tue Aug 4 13:37:25 2020 +0300

    Trying to install to the same place as homebrew
---
 README.md | 30 ++++++++++++++++++++++--------
 1 file changed, 22 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 1815ae9..6cf534b 100644
--- a/README.md
+++ b/README.md
@@ -7,25 +7,36 @@
 
 ### Why?
 
-I wrote Brewlog to fulfill a shortcoming I felt [homebrew](https://brew.sh/) has had for a long time. I got the basic idea from [a very old issue on homebrew](https://github.com/Homebrew/legacy-homebrew/issues/10430). 
+I wrote [ `brewlog`](https://github.com/robocopAlpha/brewlog/) to patch a minor but IMHO a significant shortcoming I feel [homebrew](https://brew.sh/) has had for very long time. It is the ability to log what homebrew does. IMO it doesn’t have to be something very sophisticated i.e. integration with system-log, etc.. So, I worked on a basic idea I got from [this particular issue](https://github.com/Homebrew/legacy-homebrew/issues/10430) and developed `brewlog`. 
+
+
+
+### Why bother with a log file, when brew is so stable?
+
+`brew` is generally very stable, but occasionally it breaks compatibility when it is upgrading some packages and removes some “obsolete” versions. Generally this is fine, but in certain cases the user wants to retain those packages for compatibility with something else. I recently faced [a problem](https://github.com/brewsci/homebrew-base/issues/29) due to this. While `brewlog` can’t prevent something like this from happening, but it logs `brew` activity so it is much easier to troubleshoot (by identifying what package(s) were added/removed).
+
+
 
 ### What can `brewlog` do ?
 
 `brewlog` is simple solution that can:
 
-+ log homebrew/linuxbrew activity (`STDOUT` and `STDERR`)
-  + as it is a new command, the user still retains the freedom to run `brew [command] [formula]` and not log it to the file
-+ tail the log file to display selected number of lines.
-+ archive the log file (when user invokes the appropriate command).
-  + a new log file is created the next time `brewlog` is invoked after archiving.
++ `log` homebrew/linuxbrew activity (`STDOUT` and `STDERR`) to a logfile (default: `~/Logs/brew.log`)
+  + because brewlog is a a new command (and not an alias), the user still retains the freedom to run `brew [command] [formula]` in case they do not want to log some brew activity.
++ `tail` the `brew.log` file to display selected number of lines.
++ `archive` the brew.log file (user has to explicitly invoke this command to archive).
+  + The `brew.log` is removed during archiving, a new log file is created on the next run of `brewlog`.
 
-Now you'll be easily able to track the changes made by `brew upgrade`or `brew cleanup`.
+Now you're easily able to track the changes made to your system while running `brew upgrade`or `brew cleanup`.
 
 
 
 ### How to use
 
 ```sh
+# Review/Modify code
+curl -sSL 'https://raw.githubusercontent.com/robocopAlpha/brewlog/master/install.sh'
+# Install
 curl -sSL 'https://raw.githubusercontent.com/robocopAlpha/brewlog/master/install.sh' | bash
 
 # Show help
@@ -39,6 +50,8 @@ brewlog info ffmpeg
 brewlog list --multiple --versions
 ```
 
+
+
 ### Detailed usage
 
 ```
@@ -69,10 +82,11 @@ Homebrew/Linuxbrew Function examples:
 
 
 
-**Note:**
+### Notice about the command `brew log`:
 
 + Not to be confused with `brew log` which shows the commit history (similar to `git log`). 
 + I'm open to a new name, but for now as I personally don’t use `brew log`, I had no “merge conflicts” in my brain while assigning  `brewlog` to achive my desired result of logging brew output :) [*IMHO* `brew history` *might have been a better name for* `brew log`]
 
 
 
+© Deepankar Chakroborty, 2020. All rights reserved. 
\ No newline at end of file