From b08c7f9c9ca9e42625277620252cc32c235a51a6 Mon Sep 17 00:00:00 2001 From: Ellet Date: Mon, 8 Jul 2024 18:15:16 +0300 Subject: [PATCH] docs: update README.md and CONTRIBUTING to use GitHub admonitions in blockquotes --- CONTRIBUTING.md | 5 ++++- README.md | 4 +++- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 91ffa05..d646df3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,6 +11,7 @@ If you don't have anything specific in mind to improve or fix, you can take a lo the [issues](https://github.com/FreshKernel/kraft-sync/issues) or take a look at the todos of the project, they all start with `TODO:` so you can search in your IDE or use the todos tab of the IDE +> [!IMPORTANT] > We highly recommend contacting us if you're planning to make big changes. ## 📋 Requirements @@ -91,14 +92,16 @@ If you need to change the working directory for the script, for example, when te launcher, then you will need to manually create a run configuration like we discussed above +> [!TIP] > The sync script might ask you the url for the sync info where it will send the GET request.
> Consider uploading the file on your local machine on `localhost` server > to speed up the development and lower the resource cost. > > The same applies for the mods, resource-packs, etc... > -> Use [dev-local-server](dev-local-server/README.md) module +> Use [dev-local-server](dev-local-server/README.md) module. +> [!NOTE] > If you're on **Microsoft Windows**, replace `gradlew` with `gradlew.bat`. ## 📝 Guidelines diff --git a/README.md b/README.md index 5cce726..8564363 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,8 @@ matter—unless you're confident you know what you're doing. ![Screenshot](https://github.com/FreshKernel/kraft-sync/assets/73608287/fc645eee-62a7-4f43-89ef-98677524446e) -The script might introduce **Breaking Changes** as it's still in the early stages. We will provide migration +> [!CAUTION] +> The script might introduce **Breaking Changes** as it's still in the early stages. We will provide migration instructions if there is any breaking change in each release. Some features might not be available yet, or unstable. **Kraft Sync is not affiliated @@ -67,6 +68,7 @@ a public download URL for the mod (e.g, **Modrinth**) and it will download the m You don't have to do that manually, see [Mods Info Converter] 💾 for more info. +> [!TIP] > Kraft Sync >
> The meaning of this name: