diff --git a/README.md b/README.md index c856e0a..bd0c506 100644 --- a/README.md +++ b/README.md @@ -1 +1,30 @@ -# GitWeb-Sites \ No newline at end of file +# GitWeb-Sites +This is the repository containing the community of user created sites (referred from here on out as indexes) for the GitWeb client available with MrCrayfish's Device Mod. + +## Rules of Index creation +1. You are limited to the use of domain suffixes presented in the suffix section of this file. + +2. An index must not contain advertisements of any kind in the sense of the oxford dictionary. + - *Restrictions may be lifted under certain cases.* + +3. An index must not contain obcene material of any kind in the sense of the oxford dictionary. + - *Restrictions will never be lifted under any circumstance.* + +4. The images directory is reserved for the storing of index banner images on all root suffixes. + +5. Indexes should primarily be in the English language defined by the oxford dictionary. + - *Restrictions may be lifted under certain cases.* + + +## Index Domain Suffixes +- .official - Required to be used only by moderation team of **GitWeb**! + - *for subsites/subindexes - Standard multiple use case suffix* + +- .app - Required to be used as information indexes on Device Mod addons! + - *for subsites/subindexes - Standard multiple use case suffix* + +- .wiki - Recommened for information based indexes! + +- .craft - Standard multiple use case suffix! + +- .web - Standard multiple use case suffix!