Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
isturiz committed Jun 25, 2024
1 parent 03664e9 commit 1efb878
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,15 @@ node --run start
```
You will be prompted to enter the GitHub username, the minimum year, and the maximum year for fetching contributions. Additionally, you can decide whether to execute the script immediately or not.

Execute Immediately: If you choose `yes`, the commits will be generated and executed immediately.
Generate Script Only: If you choose `no`, the commits will be generated in the `script.sh` file for manual execution later.
- Execute Immediately: If you choose `yes`, the commits will be generated and executed immediately.
- Generate Script Only: If you choose `no`, the commits will be generated in the `script.sh` file for manual execution later.

Once the script has been executed or generated, you can push the changes to your GitHub repository with:

```sh
git push origin main
```

### Inspiration

This project was inspired by the work of [charpeni](https://github.com/charpeni) in [sync-external-contributions](https://github.com/charpeni/sync-external-contributions). However, since the original project is no longer maintained and doesn't work as of today, I created this project to fulfill the same need.

0 comments on commit 1efb878

Please sign in to comment.