Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
meetjohngray committed Feb 15, 2023
1 parent 6ccbed5 commit 691d278
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,14 @@ current local repository. For more context, see the

Starting with version 0.2.0, the script also blanks out the global git config for `user.name` and `user.email`. We found some students would forget to run this script before committing and they would follow the git instructions to set the global user settings. Any future devs on that machine who also forgot to run this script before committing would unknowingly get the global settings. This change attempts to mitigate that scenario.

Version 1.0.2 makes a further change so that the behaviour described above only occurs if the `--on-campus` flag is used during configuration since this behaviour is not ideal for people working from their personal machines.

## Installation

```sh
yarn global add git-iam
yarn global add @devacademy/git-iam
# or
npm install git-iam --global
npm i -g @devacademy/git-iam
```

## Create users.json
Expand Down

0 comments on commit 691d278

Please sign in to comment.