Skip to content

Commit 72328b1

Browse files
committed
feat: add README.MD, and fix LICENSE
1 parent 317508d commit 72328b1

File tree

4 files changed

+44
-12
lines changed

4 files changed

+44
-12
lines changed

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2020 - 2022 Jorel Ali
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.MD

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# CommandAPI-Docs
2+
3+
**Working In Progress**
4+
5+
Documentation for CommandAPI.
6+
7+
## License
8+
9+
All things in this repository **EXPECT** `docs/.vitepress/theme/components/Authors.vue`(this file is licensed under CC BY-NC-SA 4.0 License) is licensed under MIT License.

docs/.vitepress/theme/components/Authors.vue

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
<!--modified from https://github.com/FabricMC/fabric-docs , original license is CC BY-NC-SA 4.0 -->
2+
<!--this file is licensed under CC BY-NC-SA 4.0-->
23

34
<script setup lang="ts">
45
import {onContentUpdated, useData, useRoute} from "vitepress";

docs/en/index.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,24 @@
33
layout: home
44

55
hero:
6-
name: "CommandAPI"
7-
text: "Docs of CommandAPI"
8-
tagline: My great project tagline
6+
name: "Command API"
7+
tagline: An API for the command UI introduced in Minecraft 1.13
98
actions:
109
- theme: brand
1110
text: Introduction
1211
link: /intro
13-
# - theme: alt
14-
# text: API Examples
15-
# link: /api-examples
12+
- theme: alt
13+
text: Download
14+
link: https://github.com/CommandAPI/CommandAPI/releases/latest
1615

1716
features:
18-
- title: Feature A
19-
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
20-
- title: Feature B
21-
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
22-
- title: Feature C
23-
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
17+
- title: Better Commands & Arguments
18+
details: Prevent invalid commands and support over 50 arguments with built-in error checking, suggestions, tooltips, and precise permission.
19+
- title: Just Like Vanilla Commands
20+
details: Let your command to be executed by the built in <code>/execute</code> command, commandblocks, functions and tags.
21+
- title: Easy to Register
22+
details: No need to edit <code>plugin.yml</code>, supports Kotlin DSL, and Brigadier-like <code>CommandTree</code>. And provide detailed documentation.
23+
2424
---
2525

26+
<br/>

0 commit comments

Comments
 (0)