From b5662a3414c6c9fa4130156595ce8787d457de36 Mon Sep 17 00:00:00 2001 From: rafl Date: Wed, 11 Dec 2013 12:05:24 +0100 Subject: [PATCH] added images to readme --- README.md | 26 +++++++++++++++----------- docs/img/docs-source-elements.png | Bin 0 -> 2682 bytes docs/img/docs-sprite-sizes.png | Bin 0 -> 5401 bytes 3 files changed, 15 insertions(+), 11 deletions(-) create mode 100644 docs/img/docs-source-elements.png create mode 100644 docs/img/docs-sprite-sizes.png diff --git a/README.md b/README.md index 518b269..632e7d5 100755 --- a/README.md +++ b/README.md @@ -91,6 +91,14 @@ Type: `Number` Default value: `10` Defines unit size of the grid the sprite elements snap to. +``` + +#### options.refSize +Type: `String|Number` + +Defines the basic height of your source svg-elements. All other sizes will be calculated relating to this. It can either be a key from the `sizes` option (which refers to a number) or just a raw number. + +![Source elements and refSize](https://raw.github.com/drdk/dr-grunt-svg-sprites/master/docs/docs-source-elements.png) #### options.sizes Type: `Object` @@ -99,15 +107,11 @@ A hash of size labels and values (`Number`) that define the different sizes of t ```javascript sizes: { - large: 30, - small: 15 + large: 39, + small: 13 } -``` - -#### options.refSize -Type: `String|Number` -Defines the basic height of your source svg-elements. All other sizes will be calculated relating to this. It can either be a key from the `sizes` option (which refers to a number) or just a raw number. +![sizes](https://raw.github.com/drdk/dr-grunt-svg-sprites/master/docs/docs-sprite-sizes.png) ### Usage Examples @@ -124,11 +128,11 @@ grunt.initConfig({ shapes: { options: { sizes: { - xlarge: 36, - large: 24, - small: 16 + large: 39, + medium: 26, + small: 13 }, - refSize: "large", + refSize: "medium", unit: 8 } } diff --git a/docs/img/docs-source-elements.png b/docs/img/docs-source-elements.png new file mode 100644 index 0000000000000000000000000000000000000000..1a22643323a947633db0591d4888b4afd8a47194 GIT binary patch literal 2682 zcmZuzdpMM78y|EK21#~lX>DW}WXq{>whnpAl$ps{4mDb=897A5kYZ9Qsu?mw;++gR zq#VMah@97pa@Hh=mqZ!lFnqK7eeJb>eE&SZ=ee%?{@wR|{qF02?(3(pwn#ArF$4mE zv^!>nLm-49!Tr9dh~V6u-mDgYe5kc^D4y&a8txrTL|B|7`w)M&3-mru#1XyEUAoXh zG!__nojO6VMk0|*JRTN{t?Kmdd0boYd0_$Ann@;gwHc32#!^ z!5E|KDc*9ItzRz4AW%pIeFp*%L4ZP+p?|RP6cb&z*CaWuGq;S$!8;cuKy&o8w~Ro^ zZ`{c{`#GOZFRh*num98FhYr$(UEAy90C6pJcA?h&yEpbau31dnE;+%zDev~;j^(+f zSXX#*_r3Burx-Q-h>%6yPlJ%(F<4&~u}5PLIoZxXeze@D=CSTBG{FRScvRt!z^SiG zKV-GW*XCi5y3FVU`@}A*Gqlq_oO4y4$?$MTcUX7dbnoS`L%Fpr31^nIJ#N>bMrf~Q zr4DKt=lcGF<}^qaQULKn4^DO!E_Qd-O5W*;fpP77=fig4_Ll%WI_WndouwPs+MQP! z5KuM4G&nFB&E-a2OnZ?EvPrP|NSuI-MW{kWak3>At%Z(2W|h5AsiOKkI?&4c-pfpg z#>NT?I1{4-LbTF@=i~dBZbj5!mW-<&YlhP3yB4iA7qz#q403#mg|%f7csZr*JxpS! zUdOOmhNFoUzdkXI7;Pmw+S~r5Ak)R^h(V-ENm-y)$BfPgT*UKi#QpM=l+rVCDB^(9 zH^O`h)VOPyChP^l%7{}6|0wqVl{5E4Jk%8^`8WR8{Gsl@-2_5^7d(OeyxV1{xv(Z<7Ah-DZvfj?djKMeE;hzmFO;CEir6keIabi-z zsWZN~s=09+TeNqzGU6_7P?U7s9;l!W4?AG`kwVFINdGJov%j?{DcvZa-IeZ7Lmab# znO~urxsd%8GSm_CE8lzdf0cR}Zp>Ahm?(BmHT3vJMm6|I)3MBV8IAUrtV{(lZS{<;Mb^(Ee5D zJZSxN615bl%dlM(u1;a|RPCCvJs}$Wi;{?}73W;Y$qqweX5wLd0_40Tc&`?bdDPfmF)z#vhb<3epYs0U^>Fq*1AwBayg zRAT7!_?iKMKl+x>+IhyLecKaY@2~XHPqm%UQ@O9cc*?#aUDKqM93Ui{@#aZK+}2k? zT^lLTolV~Weefg~I2-*f2l!!d@a_OEsI6?m23M-zq^PS56qA2c45S&RLjoJKmnB&Q zCPn;$Z(@73X4)xNe4CthJ_1}RAor_*JY{!SL}DF=y;)CWMu{zzWmsSEnP%=nr67G! zkiMxILSo$o1RZyj2Z6uol+r z1uo7rI`KG#c-wp+y^8JKa&ySA%yaTpVS&`dQ%o+ zV-_ghDbJ69W6gSn7g3z9Ya0CbmP(r$a_u?1KUMfa%qDxOdQAcOfqu0|x+MF>L+A(d zw0-=3iQNX$A|V3aTLNCKk6isEuN~keQ!H#ts*Owkaz&ngCh73nQ~6&=X_71_N}WOh zPvnS|ZaJa{ZK7{yMrU z(mjr)NS=9<&f$KYeQ(TmkD+8}+t?nY z3?!YYj|^3wSEHAAg}-|&<;*#L3=V%3@pxwpd5fPqq$BgL4SZr&WR{NPS5 zK7^fVm?E z{_ZB#@y2Q>>a35rwY`YSNGcP3+Jyvw)5ru%y9WLQSpnmgGaM5TLERHz_LFo{r-jL* zTinev{iWC4%x=o(H^t{Ot4VDXwY3o8Ism?T-O@jMBy3U>|0FqV%j$SwMp|xLahXpj zUllJu-ivi0b}UQ>Eghw(g?Hs%pN&q)%T|ao^7mh{m?DR>M7Kpda4kG4hr?J3c=eg> zt!ah2OEs#q(|5=wQ`%Kpz_^lFk3`aK$E+NgxfVF>`33voQ+l%bxt`83n-|YtF@Nu* zt~DdvgX$oR%ZG`8`ZoqOvddTz?$r{u?`mb|7QP*>&l(R7-a0W;`Kk%ow;{=9MJ)>= z9~4ApKvgfM83q1spr55`4U|U5=?84@Z9N+Du2x>sHA=c~;-l=0j6rZ7)(;j>8tvQ` zTYrea)Mk?ytj>q6?{?S(t;7Tv#A?##Bi+Ot${TWW`lcS@6()^fjkk&W^aw`$iO=CI zhpM5ppQXR)0q4UCxdrxGzmuG^YNa&`0aC=2^ndh$y4dWr9R7nijc1_#8 zY3;&U+DvAa@9CV-iX+xPFSyY^uOEC7Se)m%?C+}I^M%5BR6WY)-U(1DJ*wJrpyP3+ z!*5i~MBiUI&g0kom23kdF`*G&ulJ0rrOl~dZDg=k%x)}jl}~FYE#7NirdxdY*BABo kTJ^nq1PHy45!!(;caNW!)gYt`_C$o8HP))g((B590K2I?yZ`_I literal 0 HcmV?d00001 diff --git a/docs/img/docs-sprite-sizes.png b/docs/img/docs-sprite-sizes.png new file mode 100644 index 0000000000000000000000000000000000000000..4769d6989a1a8dfdc1853ac0a04411c124e07782 GIT binary patch literal 5401 zcmai2c{o&m-yX(N6iOjAOp!v!QW%6Rb0+(qoh%uQbqXVUl86~HLMb`+n9A5mX_-P| z$TG4ELx_fv^;N&;>3y!}y58&k>s;r)KA+F^z0dcY?|t7V(bO2ZpG%kv0)gyD0lMZ8 z2rCr=VG-B^-9>Jkj4s-}9Kq^c##;D$VnbYmJRsWc{#QKUD2(e>4|5M!_prc^9_qVA zE~bW-dSAvKt*$U=G#UnjF*Y{-kXhN(=|v|%5l=l5$Vp>k)!T19Q?fa86++~{sLU(E!(_RUMCnxBApSC=}D;6VN)QlEp zX^}cUWBS5{g$+Eu2hice--5&UYikL!Qu+Qt@O#0%MfciFMD!fWo@y@a=OfF3M-In! zz1VkCKl{1D4<#y-V-M{x^@M2_!W1a8QhPS{DEkj$_A2p84Xdj8jy0gX+eT{9>5L9D zV^?r34duD#)eX_!xM*iK&rZce zqxmUj`s8(kgPI}KHbM2Q(J7m3gmLah2y#n3wwKM7=+fEuPu7O6cG!_pM~9U9ag{CTXqT04Rs4OV-dI=VH7* zGM4*3$dmjrlfG<4)wH&!33&WFdU=Obw=jP?4Zdl>zaq4B~n z19qt*$73)UE8Hpe*y$L$%*!3ahgQh)`l!T0J#{g=mKRLmo%|#kz3Hj-OW1=_OLg-@ zlKM)tY)pBD+UoASahg8;LL9UoU(yO@PKc|^~MTW@gvFTk|0E+(ZMC+F(ZrMl+~AsXj^c|1{{)M z9}QA0=Eh%uQmvPadatv(T-o#+BQ&1fT$p(_m^p>*X)hTYwRn4y(D8MVC7|*X{NZr2 z6g!oITsKM+xnDTF4}xkx@$d}3a3}=TGIS?D#jV$jG9XN~U9uj~XLV6Q$)y#>FzNxy zA|a*b0Hhm*i&4VZF2Z0zuRSj8(##25k8U_2w*Uc*zD zrYs7H>Pk8@AzRx%?S(+50W~+tUtka)DB$d;IKv9^CNns9I3FDE5QJRi0k1ZNOQtmJ zpO5-Id`mSYeESwYMe}%53`9H_{t!Z+H~|w7JzN2cCJmm+Ud$^0aSHk78f+`Ot&3C+ zheh#dHJ+!^)meZTh8bb|_0BLFcOLv1#)>DIU*9LGF%_irP#OgeYSo8B{71EheSuRy z+2AZxPCc4b<9?eNC5zH2BKR&-3n7g=ZLbK)ti!*A&~;A0 znA!-Zm9wgX)XE2<2gmC*kIvTLd^+uQp>F{7k{x{WB(vpQaH|8LriHTt_u43KmhrkC zMAwK?7w!Pl!N)b)@ChC(!Q{{L2EnQbN<1-F(B5vxr$t@l_H0~^PJPi%QwQHw?pF@L zh8E5Utg|7;5+AgtJ{GSYZN#bRyPIfb*G3Q)W;aNo@m2!%Ti?3)vq~y5Pws;hQE6II_kcR53j9psy+=S z01*VB=s1A?{r$;W2CI}N8~5p-O4FsnM-s?Z`|ibSs|R}^A5kaz<3j7lJ9R{3XU5bI z7#+*(xbwO-poASbs#`CkUF7Wj{FWGIEVec#>CBc~?E|_9?-dh$#2Nk5Z!rd1xXK!t zcW(HUz+gIgFyq$H%bPg{32+T5RFrY|bR-)DASEjWQjX78@I^Uvb)S#6hi44gz7tqF9eXd3AyTkB8j~rXk_Zjm87TlpZcOf{S@@ny!h*-i;R>$x`K7?9Q7 zHPIL_AeH>VP8fX!+xg~{*7|ASYQ+(7C?4t(>bw4;{6&5l<9?r6Iy4MD@+LP7-2ZFm zywT^QkaXrmRwE}bKuW?|3t3bvQEl8PA1A$^eLp+nRsAggy-0uS#`K;EfHK9(CwG@z zM}6ZmzyjLr?!!JQ2Lz;W!AT*k+1ytF_0~Ymd+N}0X35wwph1FgT@Xn#RK+k{1%5NL zcD3vs2XcfyDyl>(|GHlA$j>=@q^r$Css|Nx#Qa0n?ndmBwnsp|T~p}Zu41DmXwww# zlB-mx-}-tWLN^dTUzIp@3bih`bfHao*=T2}uC5Ma<3Of!`ZC#nIZOxMbe{S=44n8z z$h8a?Dn}$cy3=2dzDUlW$P?K|wgs;OR5>&*3v$n$QH%6j7D4}Rc>54aFS=SSa1qB? zBM&5As(gB1Z=PG$Ko!@NQa6(}-8Y8Rhy(0@vc0l{(w7xZl!@OO5#rh9j+5AV#Ia1& zsc+;-(TY50Kt7}P)wV}gLjX%Q>^}YtnFdbysfyktmxE5NzRkAV8}s$e)0elyZ&3b` z)!`k@?2{}0QQKeFWh1?Jo;ANt^7u49?cavGk$}?N+1l9LL3Oi4ww^Q^nWuyjFQfxB zwGwg37-!8n-2BE5;)DZ5gb__l-==NwBz{L+Bb zr8`9{?m8&;UBmUqT*js(VBcmA&K^_vHq)hk{I$Kcyim7zDghYc19(D%lWO@U2GHYzzyXU*U&1D6~~5WUwy~&wny0~?$j2m zHd>Wk#2K5DO-b2) zc99nU&66;dY%a{#s%}|aH1_z}?XWT9~Z1~vF&q^<{6eCI}T&jFLkxzRP z%y9wW^fk*6v*wc3*R2gDcgL7AWxogABCOuLhe-6iSdPRQk$MaFNC4k3^rh>}>wTqG zSGm^7BlU3(nNy`~;`|?86LPTc*N8?*7mXWC*5LY2&}5hMcTmJ@OX1{tacKIlcZH5wm5tmRjM6^-;$6 zl=B;*3RQlQ!$E>XQn2>s&zZ>2&!bu<^U{cTdF06b^~P_qXPi0FS5o~kD-*~1+U_FO zhk7z)m@cY*_OUz?@csYffxnjjZ$kJ7`OnPo_bvTf^Z%p>u@u2DorH^aoo|}lg%SIy zD|3ZnE5_O@9O$hpX!vdppl{@qNb=sFX7Ad1N7WLhN&YUeUEx2xl2j0*M79A%NjcX3 zM&|x!%bkt)gLzH4BEutwj>m@@FAD=YYBK8C$`&?&vK*0v+IfKx*_c(|L1hXWK+#^L zcuHGRX^x>U`va`Jv zo}MNe$yFS)d!S)X`jv@B+O<4un2%~kFq->ba?NN)`PF!vnKFMZxXJEp^$qpT&-ge~ z!q!RzC<8gX?<>hemCnaPYPQz<@|@*h52ds<8B9_z?Yrao}Y6x*56?^&6 z*d#KrjWC=ww&{-T*X)(-U^IkHOM}M}psNV)TQ;!#3E`YDoxx9)#B)%a@P(FnPjjCfCW}{_rov0- z&Ji@&=O?27i3mb@^gYJcPcHs1P_*oxdns%LrtwnsFlS zJn6VXs1@#+i>VAuQw#?Eqd5+Dacl+IM@fv@O9NLRRM({^1QxBaF5M3})IoW!)EFRK zLBk+d&n5Hbz>8Jd=* z{_lf;EPuei-TJ_y_Y&VjLPu8rrPZTMcI3tE)S$-`^sKH8wY1_j^6>oEQv<`yt?O?+ zz6u`OizjtSgy>$c;f`}s7_%NjM#*7g8>gR|GoBVvp?V#v$zQ70{6bSau!KkSvd z-0e%3%EH9vIEG59N>52yJe*9(9!Lyd5$L&~OwA=1zId{1Nb)ILDRrUM`JW$dsA;e+ zk5!O*!{}e^9$r`~4GBfAzr?Iy3ckN*4dem8jMTC!n4i4AY2o=LnP7R_`wG4^IlZpG ztf;wU!-_wH&STiW95=8cP()HMHYQT<&?-F@&NP)i5PO|;cYfisqg7dUdu;XU-~#n+ z+3*;YjS7DW1La0Ez#FmVI`Tk75ez)~E5C zw;mfZz2c)#2 zDJP>%Z%}kl3e<>D(m=_~qYb1GXl`^4LE*{Dft2M^i%L5aOV7E9Y)Ad%lArLV_*2nX z550L?i_jl}A4JYqH`LTym&<@TkIBsICfe6Fu_08Nb)>y`-B3b?O?Ix&P}Y>0(ps!Q7m&XW%dew@~@7cNY7i@j&EgI-Bm?t<$MIF+B0N}~PDC@H*6 z>>N^GGBgXf8tiXpu9i2fFAezyFdyF-`4zmGTk}OxfV~TaPub_ZpcXMCAF$^db`Gz> zFJX{|nHElGh6;)3SF_AUzxXUNg7Er$(|_wJtVTwglOKQUugd+G5(<~^aG!;UR}J

Fr$^o(^YF1p1253fyOC;$Ke literal 0 HcmV?d00001