Skip to content

Commit 5ddd0a2

Browse files
committed
docs: add to do and usage sections to README.md
1 parent 917b865 commit 5ddd0a2

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.md

+15-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
# Babble
88

9-
An upgrade routine for Homebrew, Mac App Store and macOS
9+
An upgrade routine for Homebrew, Mac App Store and macOS, written in shell.
1010

1111
## Example session
1212

@@ -23,6 +23,20 @@ curl --silent "https://raw.githubusercontent.com/toobuntu/babble/main/bbl" --out
2323

2424
Change `<path>` to the path of your choice. `"$HOME/Downloads"`, `"$HOME/bin"` and `"$HOME/devel"` are all common possibilities.
2525

26+
## Usage
27+
28+
```sh
29+
bbl
30+
```
31+
32+
## To do
33+
34+
- Use a configuration file to supply a list of GUI apps which should be quit prior to upgrading them and restarted after the upgrade is completed.
35+
- Remove extraneous code comments.
36+
- Only run `brew upgrade` if `brew outdated` reports something upgradable, similar to how `mas` is already handled in Babble.
37+
- Do not attempt to upgrade the terminal being used to run Babble itself.
38+
39+
2640
---
2741

2842
#### Babble uses the following open source icons:

0 commit comments

Comments
 (0)