Skip to content

Commit fa07d73

Browse files
committed
Readme cleanups
* Make warning about the git version being stale on macOS explicitly call out security implications. * Minor formatting and typo cleanups * Ask for credit comment in scripts added
1 parent 4320dbb commit fa07d73

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ If you wrote one of these scripts and want it removed from this collection, plea
3838

3939
### Pre-requisites
4040

41-
A relatively recent version of `git`. The version of `git` Apple includes in macOS is very stale. You should really `brew install git` to get the current version if you're on macOS.
41+
A relatively recent version of `git`. The version of `git` Apple includes in macOS is very stale. You should really `brew install git` to get the current version if you're on macOS - if not for features, for security updates.
4242

4343
### Antigen
4444

@@ -80,7 +80,7 @@ Nothing here actually requires you to use ZSH or zgen, that's just a convenient
8080

8181
If you aren't using any ZSH frameworks, or if you're a `bash` user, do the following steps:
8282

83-
1. git clone this repository
83+
1. `git clone` this repository
8484
2. Add `cloneDirectory/bin` to your `$PATH`.
8585

8686
## Included Scripts
@@ -196,7 +196,7 @@ Here are some helpful aliases for your `~/.gitconfig`
196196

197197
* Kate Hudson maintains the [git flight rules](https://github.com/k88hudson/git-flight-rules) collection of useful git usage tips.
198198

199-
* [git-tips/tips](https://github.com/git-tips/tips) is a collection of git tips
199+
* [git-tips/tips](https://github.com/git-tips/tips) is a collection of git tips.
200200

201201
* Christian Neukirchen wrote a great blog post, [A Grab Bag of Git Tricks](http://chneukirchen.org/blog/archive/2013/01/a-grab-bag-of-git-tricks.html) on git that is the source for several scripts in this collection.
202202

@@ -282,5 +282,5 @@ git config --global url."https://github".insteadOf git://github
282282

283283
## Contributing
284284

285-
* Please include an entry in the credits section of README.md for any scripts in your PRs so authors get their work credited correctly.
285+
* Please include an entry both in the credits section of README.md for any scripts and a credit comment in the script itself in your PRs so authors get their work credited correctly.
286286
* Please use `#!/usr/bin/env interpreter` instead of a direct path to the interpreter, this makes it easier for people to use more recent versions when the ones packaged with their OS (macOS and CentOS, I'm looking at you!) are stale.

0 commit comments

Comments
 (0)