Skip to content

Commit

Permalink
docs: update README.md and CONTRIBUTING to use GitHub admonitions in …
Browse files Browse the repository at this point in the history
…blockquotes
  • Loading branch information
Ellet committed Jul 8, 2024
1 parent d8b1872 commit 157dc61
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -91,14 +92,14 @@ 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.<br>
> 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
> If you're on **Microsoft Windows**, replace `gradlew` with `gradlew.bat`.
## 📝 Guidelines
Expand Down
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
> <img src="common/src/main/resources/apple.png" height="30px" align="center"/> <br>
> The meaning of this name:
Expand Down

0 comments on commit 157dc61

Please sign in to comment.