Skip to content

Commit 32953b9

Browse files
authored
Improved README readability
1 parent 78946ef commit 32953b9

File tree

1 file changed

+30
-22
lines changed

1 file changed

+30
-22
lines changed

README.md

Lines changed: 30 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,51 @@
1-
commit-bot
2-
==========
1+
# commit-bot
32

4-
Automatically generates GitHub activity
3+
Generate Organic™ GitHub activity
4+
<br>_My most insidious idea yet_
55

6-
My most insidious idea yet.
6+
Once a day (if my laptop is open),
7+
<br>commit-bot adds today's line:
78

8-
Example:
99
```
10-
Commit: Sun Sep 22 22:00:01 EDT 2019
1110
Commit: Wed Sep 25 22:00:00 EDT 2019
12-
Commit: Mon Sep 30 22:00:00 EDT 2019
13-
Commit: Tue Oct 1 22:00:00 EDT 2019
14-
Commit: Wed Oct 2 22:00:00 EDT 2019
1511
```
1612

1713
This is a Bash script
1814
<br>designed to be run locally
19-
<br>right on your machine
15+
<br>(i.e. on _your_ machine)
2016

2117
> But [@theshteves](https://github.com/theshteves),
2218
> <br>I want this to run every day
2319
2420
_Oh hush_
25-
<br>Nobody commits every day
2621

27-
Is that what you want?
22+
Nobody commits every day
23+
<br>Is that what you want?
24+
<br>🚫 Sorry, not today
2825

29-
Sorry, not today 🚫
26+
We're looking for a more realistic distribution of activity throughout the year
3027

3128
## Getting Started
3229

3330
If you're on Windows™,
34-
[setup the Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install-win10)
31+
<br>[setup the Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install-win10)
3532

36-
If you haven't already, [install git](https://github.com/git-guides/install-git)**
33+
If you haven't already,
34+
<br>[install git](https://github.com/git-guides/install-git)
3735

3836
1. Open your command-line
3937
<br>& navigate to whatever folder you prefer
4038

41-
2. Download this project
39+
2. Fork this project
40+
41+
2. Download your new copy of this project
4242

4343
```shell
44-
git clone https://github.com/theshteves/commit-bot.git
44+
git clone https://github.com/<your-github-username>/commit-bot.git
4545
```
4646

47+
**Don't forget to include your username**
48+
4749
3. Test run the script
4850
<br>in case you need to fix permissions issues
4951

@@ -57,21 +59,27 @@ source ./commit-bot/bot.sh
5759
crontab -e
5860
```
5961

60-
> Tip: if this makes your screen almost blank
62+
> NOTE:
63+
> <br>If this makes your screen almost blank
6164
> <br>with no toolbar of keys to navigate,
6265
> <br>you've probably entered the text editor Vim
6366
> <br>
6467
> <br>Remember, press "i" to start [i]nserting text
65-
> <br>then when you're finished
68+
> <br>
69+
> <br>When you're finished,
6670
> <br>press "Esc" repeatedly until nothing happens
67-
> <br>& type ":wq" to save & quit
71+
> <br>
72+
> <br>Then type ":wq" to save & quit
6873
> <br>or ":q!" to quit without saving
6974
70-
5. Add this line to [schedule every 10pm or whatever](https://crontab.guru/#0_22_*_*_*)
75+
5. Add this line to [schedule every 10pm or whenever](https://crontab.guru/#0_22_*_*_*)
7176

7277
```shell
7378
0 22 * * * source /<full-path-to-your-folder>/commit-bot/bot.sh
7479
```
7580

76-
> Tip: Make sure you save your changes
81+
**Do not forget to include the correct folder path**
82+
83+
> NOTE:
84+
> <br>Make sure you save your changes
7785
> <br>on your way out!

0 commit comments

Comments
 (0)