diff --git a/README.md b/README.md index 925c6c5..0bfd48b 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,26 @@ # skinpreview3d.js -TODO: finish readme \ No newline at end of file +This is a Three.js powered Minecraft skin renderer packaged as a jQuery plugin. + +The code was originally created by [Kent Rasmussen](https://github.com/earthiverse). You can find out more about his project [here](https://github.com/earthiverse/3D-Minecraft-Skin-Viewer). + + +# Usage +HTML +``` +
+ +
+``` + +JS +``` +$(function() { + $("#canvas_container").skinPreview3D({ + imageUrl: "/img/ref.png", + canvasID: "canvas" + }); +}); +``` + +# Todo +* Create a demo hosted on github pages diff --git a/misc/init.sh b/misc/init.sh index 83686c4..0422190 100644 --- a/misc/init.sh +++ b/misc/init.sh @@ -5,6 +5,6 @@ apt-get install nginx -y > /dev/null echo "nginx Config files" rm -rf /etc/nginx/sites-available/default rm -rf /etc/nginx/sites-enabled/default -ln -s /var/www/nginx_vhost /etc/nginx/sites-enabled/ +ln -s /var/www/misc/nginx_vhost /etc/nginx/sites-enabled/ service nginx restart \ No newline at end of file diff --git a/misc/nginx_vhost b/misc/nginx_vhost index b399c9e..9a8cde8 100644 --- a/misc/nginx_vhost +++ b/misc/nginx_vhost @@ -5,11 +5,6 @@ server { index index.html index.htm; server_name localhost; - sendfile off; - large_client_header_buffers 8 16k; - client_header_buffer_size 8k; - client_max_body_size 4m; - location / { try_files $uri $uri/ /index.php; }