azures04/crafatar
1
0
Fork 0
mirror of https://github.com/azures04/crafatar.git synced 2026-03-22 07:51:17 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs improvements

Browse Source
This commit is contained in:
jomo 2014-11-24 01:49:00 +01:00
parent 509bd78c8e
commit d658a84668
3 changed files with 57 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
public/stylesheets/style.css
View File

@ -13,6 +13,11 @@ a {
color: #00B7FF;
}
a.anchor {
position: relative;
top: -50px;
}
a.forkme {
top: 0;
right: 0;

4
routes/index.js
View File

@ -1,11 +1,13 @@
var express = require('express');
var config = require('../modules/config');
var router = express.Router();
/* GET home page. */
router.get('/', function(req, res) {
res.render('index', {
title: 'Crafatar',
domain: "https://" + req.headers.host
domain: "https://" + req.headers.host,
config: config
});
});

36
views/index.jade
View File

@ -4,13 +4,19 @@ block content
.container(style= "margin-top: 70px;")
.row
.col-md-10
a(name="crafatar", class="anchor")
a(href="#crafatar")
h1 Crafatar
hr
p Welcome to Crafatar, an API for Minecraft's faces!
hr
a(name="documentation", class="anchor")
a(href="#documentation")
h2 Documentation
a(name="avatars", class="anchor")
a(href="#avatars")
h3 Avatars
p
| Replace
@ -21,18 +27,28 @@ block content
mark.green id
| ">
a(name="parameters", class="anchor")
a(href="#parameters")
h3 Parameters
a(name="size", class="anchor")
a(href="#size")
h4 size
p The size of the image in pixels, 1 - 512. <br> Default is 160.
p The size of the image in pixels, #{config.min_size} - #{config.max_size}. <br> Default is #{config.default_size}.
a(name="default", class="anchor")
a(href="#default")
h4 default
p The image to be returned when the id has no skin (404). <br> Valid options are
a(href="/avatars/00000000000000000000000000000000?default=steve") steve
| or
a(href="/avatars/00000000000000000000000000000000?default=alex") alex
| .<br> The standard value is calculated based on the id (even = alex, odd = steve)
a(name="helm", class="anchor")
a(href="#helm")
h4 helm
p Get an avatar with the second (helmet) layer applied. <br> The content of this parameter is ignored
a(name="skins", class="anchor")
a(href="#skins")
h3 Skins
p You can also get the full skin file from name or id. <br>
| Replace
@ -44,10 +60,16 @@ block content
mark.green id
| "&gt;
a(name="http-headers", class="anchor")
a(href="#http-headers")
h3 HTTP headers
p Responses come with these HTTP headers, useful for debugging.
a(name="response-time", class="anchor")
a(href="#response-time")
h4 Response-Time
p The time, in milliseconds, it took Crafatar to process the request.
a(name="x-storage-type", class="anchor")
a(href="#x-storage-type")
h4 X-Storage-Type
ul
li <b>none</b>: No external requests. Cached: User has no skin.
@ -58,15 +80,27 @@ block content
li <b>error</b>: This can happen, for example, when Mojang's servers are down.<br>
| If possible, an outdated image is be served instead.
a(name="about-usernames", class="anchor")
a(href="#about-usernames")
h3 About usernames
p We strongly advise you to use UUIDs instead of usernames in production.
| Usernames are deprecated by Mojang and you should only use usernames for testing.<br>
| Invalid usernames are rejected and a 422 is returned.
a(name="about-uuids", class="anchor")
a(href="#about-uuids")
h3 About UUIDs
p UUIDs may use the raw or dashed format.<br>
| Invalid UUIDs are rejected and a 422 is returned.
a(name="about-caching", class="anchor")
a(href="#about-caching")
h3 About caching
p Crafatar caches keeps skins for #{config.local_cache_time} seconds until they are checked for changes.<br>
| Images should be cached in browsers for #{config.browser_cache_time} seconds until a new request to Crafatar is made.
a(name="examples", class="anchor")
a(href="#examples")
h3 Examples
p Get jeb_'s avatar, 160 × 160 pixels
.code &lt;img src="#{domain}/avatars/853c80ef3c3749fdaa49938b674adae6"&gt;