Skip to content

Commit f77217b

Browse files
committed
Update README
1 parent ae532a7 commit f77217b

File tree

1 file changed

+18
-16
lines changed

1 file changed

+18
-16
lines changed

README.md

+18-16
Original file line numberDiff line numberDiff line change
@@ -11,33 +11,35 @@ Running this script rewrites history for all repository collaborators. After com
1111
1. [Download the script](https://github.com/adamdehaven/change-git-author) from GitHub and save it to an easily-accessible directory on your computer.
1212
2. Change the permissions of the script file to allow it to execute:
1313

14-
``` sh
15-
chmod +x /path/to/changeauthor.sh
16-
```
14+
``` sh
15+
chmod +x /path/to/changeauthor.sh
16+
```
1717

1818
3. Navigate into the repository with the incorrect commit history
1919

20-
``` sh
21-
cd path/to/repo
22-
```
20+
``` sh
21+
cd path/to/repo
22+
```
2323

24-
Alternatively, you can run from anywhere by passing the `--git-dir` and `--work-tree` flags.
24+
Alternatively, you can run from anywhere by passing the `--git-dir` and `--work-tree` flags.
2525

2626
4. Run the script (with or without flags)
2727

28-
``` sh
29-
./changeauthor.sh [OPTIONS]...
30-
```
28+
``` sh
29+
./changeauthor.sh [OPTIONS]...
30+
```
3131

32-
If you did not change the permissions to allow execution, you can also call the script with either of the following:
32+
If you did not change the permissions to allow execution, you can also call the script with either of the following:
3333

34-
``` sh
35-
bash ./changeauthor.sh [OPTIONS]...
34+
``` sh
35+
bash ./changeauthor.sh [OPTIONS]...
3636
37-
sh ./changeauthor.sh [OPTIONS]...
38-
```
37+
sh ./changeauthor.sh [OPTIONS]...
38+
```
39+
40+
If you run the script with no [option flags](#options), you will be prompted for the needed values via interactive prompts. The script will then proceed to update your local repository and push the changes to the specified remote.
3941

40-
If you run the script with no [option flags](#options), you will be prompted for the needed values via interactive prompts. The script will then proceed to update your local repository and push the changes to the specified remote.
42+
----
4143

4244
If you would like to suppress the git-filter-branch warning, simply add the following line the `~/.bashrc` file on your computer:
4345

0 commit comments

Comments
 (0)