diff --git a/README.md b/README.md index 5c0d77f5..763a438e 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@

A personal GitHub bot which syncs data and runs automated systems

- Version + Version License: MIT @@ -21,16 +21,24 @@ ## Information IJsblokje is a custom GitHub app build to automate a bunch of stuff, it can for example: -,- 🏷️ Label PRs automatically according to the conventional commit types,- 🔃 Sync labels across mutliple repositories and allows for specific repo labels too,- 🔔 Automatically adds the Discord feed webhook URL and enables/disables it depending on the visibility state,- 🗞️ Syncs the readme's of multiple repositories using a config and a base readme (which is located at ijsKoud/ijsKoud),- 🎉 Releases a new version with automatic changelog generation everytime a command is ran by the owner: [@ijsblokjeee[bot]](https://github.com/apps/ijsblokjeee) release v**x.y.z** + +- 🏷️ Label PRs automatically according to the conventional commit types +- 🔃 Sync labels across mutliple repositories and allows for specific repo labels too +- 🔔 Automatically adds the Discord feed webhook URL and enables/disables it depending on the visibility state +- 🗞️ Syncs the readme's of multiple repositories using a config and a base readme (which is located at ijsKoud/ijsKoud) +- 🎉 Releases a new version with automatic changelog generation everytime a command is ran by the owner: [@ijsblokjeee[bot]](https://github.com/apps/ijsblokjeee) release v**x.y.z** ## Install Although you cannot self-host this with docker due to the personal preferences and names you can edit the code to your likings and run it from there. -,To do this, simply clone the repository (`git clone `) and edit the code from there (Only edit the src/lib/constants.ts if you aren't looking to change the code). After that Rename the directory `ijsKoud` to your own GitHub username. -,Once finished, build the app (`yarn run build`) and start it by running: `yarn run start`. Do NOT forget to edit the `.env` variables first and move them to the `/data` folder (create one if it is not there yet)! + +To do this, simply clone the repository (`git clone `) and edit the code from there (Only edit the src/lib/constants.ts if you aren't looking to change the code). After that Rename the directory `ijsKoud` to your own GitHub username. + +Once finished, build the app (`yarn run build`) and start it by running: `yarn run start`. Do NOT forget to edit the `.env` variables first and move them to the `/data` folder (create one if it is not there yet)! -## Credits,- Logo: Melting ice vector created by freepik +## Credits +- Logo: Melting ice vector created by freepik ## Author