Skip to content

Commit a42428a

Browse files
docs: update README.md
1 parent 9407034 commit a42428a

File tree

1 file changed

+17
-11
lines changed

1 file changed

+17
-11
lines changed

README.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
![Version](https://img.shields.io/badge/Version-1.0.1-green)
1+
![Version](https://img.shields.io/badge/Version-2.0.1-green)
22
![Maintenance](https://img.shields.io/badge/Maintenance-Yes-green)
33
[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/rahfianugerah/sch-bot/blob/main/LICENSE)
44
![JavaScript](https://img.shields.io/badge/JavaScript-%23323330.svg?&logo=javascript&logoColor=%23F7DF1E)
@@ -29,7 +29,7 @@
2929

3030
#### Getting Started
3131
<p align="justify">
32-
To get started with this project, please refer to the <a href=#installation-guide>Installation Guide</a> and <a href=#usage-instructions>User Instruction</a> in the documentation. For additional information on contributing, please check out the Contributing Guidelines [N/A].
32+
To get started with this project, please refer to the <a href=#installation-guide>Installation Guide</a> and <a href=#interactive-bot-usage>Interactive Bot Usage</a> in the documentation. For additional information on contributing, please check out the Contributing Guidelines [N/A].
3333
</p>
3434

3535
#### Disclaimer </b>
@@ -44,27 +44,31 @@ Commit Wave is designed to automate the process of creating commits to GitHub re
4444
git clone https://github.com/rahfianugerah/commitwave.git
4545
```
4646

47-
#### Usage Instructions
48-
49-
- Enter a date range and commit(s)
50-
```javascript
51-
//Example Usage startCommitBot(startDate, endDate, commits)
52-
startCommitBot('2024-06-6', '2024-06-23', 18);
53-
```
54-
5547
- Run the app
5648
```
5749
npm start
5850
```
5951

52+
#### Interactive Bot Usage
53+
54+
- Enter a date range and commit(s)
55+
```javascript
56+
Commit Wave: Hello! I am your commit bot.
57+
Commit Wave: Please enter the start date (YYYY-MM-DD): 2025-01-10
58+
Commit Wave: Please enter the end date (YYYY-MM-DD): 2025-03-02
59+
Commit Wave: How many commits would you like to make? 10
60+
Commit Wave: Great! I will make 10 commits from 2025-01-10 to 2025-03-02.
61+
Commit Wave: Starting commits between Fri Jan 10 2025 and Sun Mar 02 2025...
62+
```
63+
6064
#### Bot Script (Github Actions Script)
6165

6266
<p align="justify">
6367
The Commit Wave project leverages a GitHub Actions script to automate commit operations. This script is configured to run on a schedule, performing 1-2 commits daily at random times. By utilizing GitHub Actions, the script ensures seamless integration with GitHub’s ecosystem, automatically pushing changes to maintain an active commit graph. The script is designed for simplicity and reliability, making it easy to set up and manage automated commits directly within your GitHub repository.
6468
</p>
6569

6670
```yml
67-
name: Bot
71+
name: Commit Wave
6872

6973
on:
7074
schedule:
@@ -124,5 +128,7 @@ on:
124128
This project is licensed under the MIT License. This means you are free to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software. The full text of the license is available in the <a href="https://github.com/rahfianugerah/commitwave/blob/main/LICENSE">LICENSE</a> file. By using this project, you agree to include the license notice and disclaimers in all copies or substantial portions of the Software. For more details on the terms and conditions of the MIT License, please refer to the license file.
125129
</p>
126130
131+
---
132+
127133
#### Project Author
128134
GitHub: [@rahfianugerah](https://www.github.com/rahfianugerah)

0 commit comments

Comments
 (0)