diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 7916d69..6b6e729 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -17,7 +17,7 @@ - [Installing](install.md) - [Flags](flags.md) -- [URLs](url.md) +- [Links](link.md) - [Namespaces](namespaces.md) - [Versioning](versioning.md) diff --git a/docs/url.md b/docs/link.md similarity index 53% rename from docs/url.md rename to docs/link.md index deb2ee9..88e534f 100644 --- a/docs/url.md +++ b/docs/link.md @@ -1,23 +1,23 @@ -# URLs +# Links -AddonScript uses URLs to point to specific files. AddonScript specifies three URL schemes, which can be used +AddonScript uses links to point to specific files. AddonScript specifies three link types, which can be used to point to files. ## http(s) `https://example.com/file.jar` -This URL scheme is mostly self-explaining. It is jsut a simple http or https URL, which points to +This link type is mostly self-explaining. It is just a simple http or https URL, which points to a file on a http server. ## mvn `mvn://com.example/someartifact/1.0/core.jar` -This URL scheme is used, to point to a maven artifact. The URL consists of multiple parts. +This link type is used, to point to a maven artifact. The link consists of multiple parts. In this example `com.example` it the namespace of the artifact, `someartifact` is the artifact ID, -`1.0` is the version, `core` is an optional specifier and `.jar` is the file ending. -`mvn://com.example/someartifact/1.0.jar` would also be a valid URL without an optional specifier. +`1.0` is the version, `core` is an optional qualifier and `.jar` is the file ending. +`mvn://com.example/someartifact/1.0.jar` would also be a valid link without an optional qualifier. ## file diff --git a/docs/packaging/zip.md b/docs/packaging/zip.md index 9088ffe..bf7a717 100644 --- a/docs/packaging/zip.md +++ b/docs/packaging/zip.md @@ -4,5 +4,5 @@ With zip packaging, the AddonScript file and the associated files are contained a zip file. The AddonScript file has to be called `addon.json` and can either be placed at the root of the zip file or, if there is just one directory in the root of the zip file, in this directory. All files and directories inside the zip file can be accessed from AddonScript -using the [file URL scheme](../url.md). The path from the file URL is relative to the location of +using the [file links](../link.md#file). The path from the file URL is relative to the location of the AddonScript file. diff --git a/docs/schema/file.md b/docs/schema/file.md index 40cb041..c901eaf 100644 --- a/docs/schema/file.md +++ b/docs/schema/file.md @@ -3,7 +3,7 @@ ```json { "id": "modfile", - "url": "https://example.com/mymod.jar", + "link": "https://example.com/mymod.jar", "flags": [], "install": [], "sha1": "somesha1checksum", @@ -24,9 +24,9 @@ If multiple file objects in the same array have the same ID, they are treated as which means that the first one of them in the array will be used unless it can't be retrieved from the URL, in which case the next one will be used as a fallback. -### url +### link -This is a [URL](../url.md), which points to the actual file. +This is a [link](../link.md), which points to the actual file. ### install diff --git a/docs/schema/meta.md b/docs/schema/meta.md index b126d5f..c0ea0e1 100644 --- a/docs/schema/meta.md +++ b/docs/schema/meta.md @@ -45,12 +45,12 @@ display to the user. ### icon -A path to the icon of the addon. This path should point to an image file of small resolution +A [link](../link.md) to the icon of the addon. This path should point to an image file of small resolution which is ideally square. It can be dispayed to users in programs. ### description -A path to a description file for the addon. The file should be in CommonMark markdown. +A [link](../link.md) to a description file for the addon. The file should be in CommonMark markdown. ### summary @@ -78,7 +78,7 @@ An array of people who have contributed to the addon. ### changelog -A path to a changelog file for the addon. +A [link](../link.md) to a changelog file for the addon. ### timestamp