Skip to content

Commit

Permalink
Merge pull request #6 from evan-gan/main
Browse files Browse the repository at this point in the history
Update readme example form JSON to YML
  • Loading branch information
PawiX25 authored Jan 3, 2025
2 parents 6c460d7 + 27f1c4f commit 79506b5
Showing 1 changed file with 22 additions and 27 deletions.
49 changes: 22 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,33 +72,28 @@ Each program object can include:

### Real Example From This Repository

Below is an example from the `limitedTime` category in `programs.json`:

```js
{
"name": "HackCraft",
"description": "Create a Minecraft mod, and Hack Club sends you Minecraft Java!",
"website": "https://hackcraft.hackclub.com/",
"slack": "https://slack.com/archives/C07NQ5QAYNQ",
"slackChannel": "#mc-modding",
"status": "active",
"deadline": "2025-01-31T23:59:59",
"detailedDescription": "Join HackCraft to build and ship your own Minecraft mod. Access exclusive resources and a supportive community.",
"steps": [
"Make a mod.",
"Publish it on Modrinth or Hangar.",
"Submit your mod to Hack Club.",
"Receive Minecraft Java Edition and enjoy!"
],
"requirements": [
"Basic knowledge of Java programming.",
"A passion for Minecraft modding."
],
"details": [
"Participants will receive a Minecraft Java Edition account upon successful submission.",
"Support is available through our Slack community."
]
}
Below is an example from the `limitedTime` category in `data.yml`:

```yml
name: HackCraft
description: Create a Minecraft mod, and Hack Club sends you Minecraft Java!
website: https://hackcraft.hackclub.com/
slack: https://slack.com/archives/C07NQ5QAYNQ
slackChannel: "#mc-modding"
status: active
deadline: 2025-01-31T23:59:59
detailedDescription: Join HackCraft to build and ship your own Minecraft mod. Access exclusive resources and a supportive community.
steps:
- Make a mod.
- Publish it on Modrinth or Hangar.
- Submit your mod to Hack Club.
- Receive Minecraft Java Edition and enjoy!
requirements:
- Basic knowledge of Java programming.
- A passion for Minecraft modding.
details:
- Participants will receive a Minecraft Java Edition account upon successful submission.
- Support is available through our Slack community.
```
## Contributing
Expand Down

0 comments on commit 79506b5

Please sign in to comment.