From b04b2684ac5323e5207d558f267c23269055af53 Mon Sep 17 00:00:00 2001 From: Noah Slater Date: Sun, 23 Mar 2014 21:01:23 +0100 Subject: [PATCH] Tidied up top-level documentation --- CONTRIBUTING.md | 17 +++++++++++++++++ LICENSE-2.0 => LICENSE.md | 6 +++++- NOTICE.md | 7 +++++++ README.md | 37 ++++--------------------------------- screenshot.png | Bin 10392 -> 0 bytes 5 files changed, 33 insertions(+), 34 deletions(-) create mode 100644 CONTRIBUTING.md rename LICENSE-2.0 => LICENSE.md (99%) create mode 100644 NOTICE.md delete mode 100644 screenshot.png diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..2711ab3 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,17 @@ +# Contributing + +## Issues + +[Open an issue](https://github.com/ds300/jetzt/issues?state=open) for anything you would like to see in jetzt, but please check other issues first. + +We also have a [TODO wiki page](https://github.com/ds300/jetzt/wiki/TODO), where ideas are collected. + +## Pull Requests + +Pull requests are welcome. + +Please submit to the `dev` branch, or to `master` if it is only a small bugfix. + +## License + +By contributing to this project you agree to license your contribution under the terms of the Apache License 2.0. diff --git a/LICENSE-2.0 b/LICENSE.md similarity index 99% rename from LICENSE-2.0 rename to LICENSE.md index f4f87bd..1f824d4 100644 --- a/LICENSE-2.0 +++ b/LICENSE.md @@ -1,4 +1,8 @@ +# License +Unless otherwise stated: + +``` Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ @@ -200,4 +204,4 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. - \ No newline at end of file +``` diff --git a/NOTICE.md b/NOTICE.md new file mode 100644 index 0000000..6244ae0 --- /dev/null +++ b/NOTICE.md @@ -0,0 +1,7 @@ +# Notice + +Unless otherwise stated: + +``` +Copyright 2014, the jetzt contributors +``` diff --git a/README.md b/README.md index c614492..71357b8 100644 --- a/README.md +++ b/README.md @@ -12,47 +12,18 @@ Here's what jetzt looks like in your browser: - Read about [how to install](https://ds300.github.io/jetzt/#install) (Chrome extension and bookmarklet) -- Consult the [usage instructions](https://ds300.github.io/jetzt/#use). +- Consult the [usage instructions](https://ds300.github.io/jetzt/#use) - Check out the [online demo](http://ds300.github.com/jetzt/demo.html) -### ToDo - -Check out the [ToDo](https://github.com/ds300/jetzt/wiki/ToDo) section of the wiki. - ### Contributions -Open an issue for anything you would like to see in jetzt, but please check other issues first. - -Pull requests are welcome. Please submit to the `dev` branch, or to `master` if it is only a small bugfix. If it is your first time contributing to jetzt, please add your name to the list below (in alphabetical order). - -### Contributors - -- [Gustav Ahlberg](https://github.com/Gyran) -- [Martin Butt](https://github.com/martinkiva) -- [@fusillicode](https://github.com/fusillicode) -- [@h0ru5](https://github.com/h0ru5) -- [Brian Hanson](https://github.com/brianjhanson) -- [@ianzapolsky](https://github.com/ianzapolsky) -- [@j6k4m8](https://github.com/j6k4m8) -- [Noah Slater](http://github.com/nslater) -- [Peter Uithoven](https://github.com/peteruithoven) -- [Pratyush Mittal](https://github.com/pratyushmittal) +We are looking for contributions! See the [CONTRIBUTING.md](CONTRIBUTING.md) for more information. ### License - Copyright 2014 David Sheldrick and contributors - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 +Licenced under the Apache License 2.0. - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. +See [LICENCE.md](LICENSE.md) and [NOTICE.md](NOTICE.md) for more information. ### | (• ◡•)| (❍ᴥ❍ʋ) diff --git a/screenshot.png b/screenshot.png deleted file mode 100644 index 90eddd86d6434cd73fa1ef85c87203adf8eddaa8..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 10392 zcmeI2Wmr^g)b9a@25CXML22o3=?>`zX;A4N0RfR3knWO{4y9XZ$)Qua8)2BUf#*G6 z&)4(ey{U{+L+k<|7=+|NKy*PhHcZ1TzDPjt3@hG>mS+^zwkW{>br zEef}=2`W;MiR$gssu_$F^XCeV#Wv#()4}Wal!k6X*#Sh9q9Aay0Yg@geL&T>B z4zMyqY({Yex68vPM0_;7Y}}K>Adoz8Q0JkmqjCQ`SiKlZ;ko00g zsYyXzP`rMf$OikkDn5mW(&LCY5W`c3M+)~M%9}>Zw>1pEc%kkq+$5mqRC8k2#o;>^ zrxt8q7P7Im1o%7}5=4f&%sGOfKzYDG7HeiEXLEXJ+u)+p^0@*Abk4~>L>({rleLmg z|HXv|`htBP4{{d2=zmSgabth$Bdcv%jR*4;_4_&h&f$qi3D?C&jk63VM9VpXXfr5y zO`yNF@VpYjv}3)hE!c~v)VrTz1oSH~0=x(JebVIW7Ej-~Ddf#JOUbne>8!kNtfm@y9T>GLVn3GNi8*lWbi2}r=sH7c1VTTe(e$sbu3AP5GSd90B6viLDW1SV zzP;`(RxZ~nZvB}Ku^S^A8;n1GeoB}dSBs~Ad15Tas{#7>0F2tJ@j0s|e3lt-S) zuLV~VMiAvno{33=m6j}^!bV7IZEYQm=PK}c?YAHl9Lh3rT#MPTXW{ICdvphvq!k&V z<=EuvN6-{dk3vS`U$8%V(G40Q5s@U^Dj1`^{T4@ByS@L76_P4%847x_5Rp`b-btM1 zNm#km)=63KCdiW#?aN27ERlw1wlt2ogMj)yTX)h5%do|rb@+WL7C^q$`^UssD#cq6N4h|P* zXI00ny(o};_B5`1&a-?Iw7;zV;)wHb>FnuS>}zp6v>bS_RS2-e!)Qe(#Vd}s4%viD zq;Fjph zTWAqE8(lMc>9D3^Btx>76V&;BtC*PzSqY9-9w-90g0=e{fQTEICT(RT-(lmf2VO&tRG z_q`WjYVUb99QSQ52q2~Iuj}h;K|#Sp?mC_Ml9tuaEEfk0Eauv}x~tC)(3#R>XNy)z z{r~oV6^CuB4fOY~7sacIdH>0ky)|$*!kS42{gexmf{HpncbnjyHmY&k9*ZL5w;#q4 zIg$XFR=b1xWU0;z4!azp#-R{e4{NuGK~##>EjK9GKdy)ZLUtQ0Sh_1u5~(EuA+(Y| zV<>-J)4<@T$Nns_iI+L--}%+Y?!gr9zG#ZHggBp3I}Z;JXJ;Qc7acMt0tYG^bs0ng zf|h?dA4ku;H$^-8O)aZ!7s@JL`VdAj(V%d&edHHh$d49=AD#isr-!bi!lOB20@~Gg zMZsF}e_THsw|Dq6o5F)m^`SvzPuvb=nuNcoqqxeozNx=R-7(_~xBbwM@;90!#n9vc z{_8mnpvDgABxv^hH+iDJ0MRAO_uxl!b2Bu?&dx4{*I_D_M%qGL#t_BO;A!hsSZ|;& z^;OU2jy7HFo7l^S)0=?H62}p`+u7cf;|^4+=JP4TcX7wPD7s$k0kgGsi^ga7N+b*+ zbX0tk7CCO2##w}e>ag9V4dyW~MS?XY+EjMTA6flzKkgG|JrAEaEUiUNT<^AqLDp29 zU$ce;ChCWV6Qk-8{Dr@sK`GHq4J|SC<@Hi&Fy1-AZ0H|#MS z`svy8tiFLHW7;$jMi(Q3-@@fQ*n9Hx!+c@D-SuXROF_h<;3c5ml0l936ZvuPJjP6| zpJPq2CsU~+Ke;{)7=`nXB(nRK!=>9s(!5iM{nvuw6Pk5hyPj(imj>4fTB_(|dQhb? zkVzLqWohN{xB^m&L=XUlw}KYYd2%tm84X)x&Vn8{+)v%rL>F5v<9YptYb$UJs_Nl5 z-$$}I@mOR}`=ZH?E*lc=4!%lI?Y^lpTWIk#>=P;-&J-0EdggGb#L>dzb!5iU3`iLh zua(e8Pi+IXRR8wBT(MIc@%H+9(+k#4P4L`#M0{1dn|BzvyIu_1M4tH}9hNA1X|L?bNyoLhCo8*fl^%Fqfv%$UdzX>F;`TK0?ga z;?A>%;Kw&*f=M>WNVCr{S=-JEIP7$=jG!thuL^Q=rC@J?pH38O)uoD9u5^aRh~G6% zid$V7F8xdVJMprXJWaRfYIeHS27^Y1u++=v3OAe=bWaU)^rI9T>2 z`HJCw(OJtYaC&<4>1L{B!{H+7mlYFRKrVX|?uE>s*8V%wt-3mm7CxxFsq zx~WmB+YWHJdDC0l)=>fpokoI28SS;l*jEWo=aZI*o+bV z*A*y0@40$x{B#hb{-A7U=UDb$eG(hFf{8E!pf~$2fpaZ&vbt}|0KX8RYhOak$QjNC zOHI4>S|qA(ln?oGh_Io(onVLt&o`TuwtT5^GL2e-uGDdCW_V^25m9EfYaKB#FeGN( z2b3%Vz)WvJ1=e2Wz8-6o--vt~`*zA18#z*c$3U+eO(W zmR2iOUw`9yI}ps36p=O znyHzc=;4P)0>O^m$dQ}{+=GZsbY47suQPc9w+bjxSrmBYSa*f^GibBna_|syNK;!(l}r%t55Y#fP=2 zuyCV(&iOO|`;UF^y;Zsa!`t#}Y(NDaF)TJ6He}|t3(N1i7^;7`?ujaWld>y+{HG(a zgyNh-r0w$O;eN*T*Ira&DsTScW1U6jKgy{*=t~>CWXlaL5d=)%jeb<;Qh=~?d}=`R9wC3g@njdUwFIOlcUf%OzFj;5x(w5(b(HT};k**kG5#+K zo}%>&Q|arnC&9k;QwwfH?A=HV1^WINH9ME6X;1Z?gi3#SufQl>Bqci_3`)bImqs6O zOroMV+Pa>=i!|~)4i}@6KBi)K&H};`{Wd)0MVEP)7Sp1|=SV4$nj%V)M(IfGUG29+ zsgn~EwH7@XyZ%cyma~9oE>Htf3WbLf9~Im=KH_+DEY3Io!4PWs@w`s|%5#1PJnI#ULp!Z5c;1g7(nJeIbJuvy%zQfhD%)cjnX;BY$RX zkQKu&eyqwBsI>_l{ei#XJa>tnU33gGopqIM41oPZ#@xH9vf+jT3jQAS8$)R~=esA# zs2(d}?I5uc6FripHiX_NvM^L8O8>JzTkpgBu8BEJnym*C4+G&hy7u=N@0O)j*U-S5 zMm*+AJYQmV?-FmQGLuvk5oR#_@PQjE!7D&;kp>^yT3gElZaI(s{**!}go)q`(=R!L z-)VM&K;7$O?z_LG+e@KwRl)mluJi1#a9yMJ(yz%cOnGX3C{N(^iJH1OD~#B8TrU~!ez{9)SH|NRlJjRk zxI}Kw#KEGz7eyG1^s{2|(S7jh>hEguE*e4|1(Z{v7LjAUn@yFqL}??zR$lb62Ouv8 zo`n&!u{HQn7tRpZ5l#cB)oyk#nyW7C*q^j-mpijC8^5CD(_ z(u@0ejDAu3oUpBG1;%L8=rziw(6BwEVGB4zY!EjRq14-=aTn^_^nmNXNonsa3s&vE zW!U&UoR;_raHjC)`JTLrYLWO$jvTAHQHu|6>uU$L_!RL#F-o`HjaZQ{ z_gh3ig`m>c{@w-z+MyH9j)lkABA+TY$E|~>uD)=wH&;dl(rn~?RCg-7|94< zcLf0f_ZzV5RDE~zmXq~v!p!6VT1)!d>$r#5_vFef-+B8!vksmB!bM?X;Ov)Zj%O+v zLcC6$*4gy2PeC8CeHZ<%qdwy_1n5o&;Z)XITmSuvCHmI^?lkp0eyI3|J#3B)rWa#S`QiQ7i#v;M;9l(hD~ zjF6z+6U*Yua!Kj;PR}bq`!tfw)jS8__XV_5e`kGdI-M3}xFha=*~9dv#d{3?^RF;W zrtM=?h1lh4;f6;|%52YM50n2TVR1dx)rjviQGE)mTnr+aYuU+9fv}!Vmj$ogq!__} zrPy^NSUk)j&%MT^Uj(j^Ew!T>A6MQ2`88k|k zlA5J-4KC!3jNIs|OkppC*n~rVsr#g;UG?Tqrn#dRWYlS4oPAUA;udiNIzoRgNcW5m}Uk4Khw_3!Gy`}9IM zSmOKT`*qJtwgm%EJ+ddrmfw^GJO)G133{<6d2{vk&vkb1{tn-i2tE5X;WTHaxb3SZ zc5LU%$)fHzW6j3}zt6zytXEo>Mn_b4+7F*7y<~9fNLdM^YWPQg&-Q{n+*{KQiV#@d1 zZ=%%yw;^tHI+;6$C#dfrHL|w3QGf7nyzR|_+$lQurrJx4+Jo;-LafEJa{bsTM^&#W z;(1+g+KI`UNW_GHw#IW1N~ zIwx!u4jXTa_sxy+EvY2ud29Bg*^{x!`=+{}Vx?#=fN4Zn^eo_38dWS<;-72qGpo06 zOKHQ+buvQt4bT|4hV-$PgMj?8Qs$Efds#wD7xb(TH&W4Y&xgM6FEkdgMz}yBtJg6X zv^Cru33m~@hJG5&9iN{$-TcfG&}G!qH2B^!3L+LE#|KuVC> z5`FJxr0(Q)Y4lGQtt1-d?Af=doHrv@NmyiGJij5MWK6vSlh|j8AMA9EOf*n=1@0e= zX8h^=qxIVAMjlNE2`_Dy7WKt-6f3e6iI5J(?*Wbic@sW?;!p}lJ)qB4NZ`b2s=#H> zfj9g7ljm#CcD?18M#Vh`mwaWHpave5h zRQz^!DqDPW{+m0d<)891N`gUWCr6>%+5L3z_+|#40bVfM+h1ocYNn^_rlr-X;wJA0 zIxXdJzR#F2jA)-_2<%Gf2hpi$8CyX5)?>U)c+{}G)W6~*mXMd23lU_3$62IQ6tEJe zP%y5fd^+Q;!XA1hj0A>6Y2=P-Nz7lnPeVnx-o3=^I-kk}QSTyt=XsL9 zy9D1dcPb3|f3LM?Dzwv&8og<;>^tBfJr0bXDwF7l{bSinrDem1d!ufAp1I&FRv{KN zmnmD&b>!+FQ6<#txTM|W@AOxdr^}MavRCzapz>8uZe3l*;Tm6zyQRxw^N;Fke2&YJ zUFgZ_>9J|^B~_YyUJ;#QcOJ2l1=EX8!gxw3)mxYoRK0K);rF$1&W`kX{*}=)O<-OMzhLq5j|_dm2yEk zN>0;6pm3y~goa-het0Z9Y>9#@LF>UdVzC2~EzAkmRG$%~l}O|b6;ZE&Hr&|UTu@Ef z7p&PIIY$G|cP3vnhdQAsKh(D5vo}FNmilHR%_W!Ww4puPA#3zRBjs8LuRB&!rD@YV zWWQs90`;TMaI>W41Vdznyz1CGxRHt4#+2C+M7#%i+{-9x5Gi4S(fgD z^-gnE?pTFBgFDQ!$mUxp#_fgAQ|g7{%^UT2U%nfFXh7A46N)-x@g3yM2QV~^s8M4sd%!b7zvk$XY*Q6p~-OmW^$Xyi!4q8tuM8~l>%`d-jh z_6tg~#Iaz1hOp;nJt>M6LcCBgc9^^!sjm3_#sF9c`g8=F_uE>3F+MRrS7atvyybr5 z_(wcWv}&b~u`kuSbM4DwjuwqfraJ2jyu^HL40T>;HeFRNHi^QMz0i|lP;Qhwb-Ha( zV$qI0f9i^Q~V2K$HB>0rFq>v(Iqdb92cyJ6-9NQCN0(~d$6m9s>e%~ z7HTqS&L7k&&7OYb9vP{1MR&%YH1SEPo0rHc2kxVio~r6Uu3v z$J2x3q&|u7Yo3?zq|S{% zb6@tQirT*UuLuW`M9|{-`Bl@#GNpEf(5cIfjZ#BQpem()Pxi&9GZe!nBC^SKr-P8u ze#9RUwhAZeygay8N6BQV<`s?>d4$q8GQ4Hwst-j&38V;ypa=tDZ8DVnrvY5*CC@y< z&61?%wlv;nd+heggK=rix1K3l6`?>Sc9y|3P3jf|Z3$x%^tcRs=2o-LMehjj=ZqRL zK4=hn)E=wJ=z47Vw6Bn|^ku*{cDI-W9uerdRU;wO)&6!Y{TwI|Px*@waI$w)%1$c0GH#;2tLIP4t+iZ=$h5 z)U@r(1%g8wN1#X!q{HMSrpPWt98AQ|I?yE0%eKUplOB~~x7lZ^cdITygO0SvP#&scynjrTB0Uh zbKIi$fkOhRm^S;B4XM47wx-TEQmDhMv!?tIQO-wPo%mW6L(-y+9B?hzG{e4;rbh$V z&jE)8P4;*l>4rwm%OS>m-XOoTv2mCMW6L;F|ky9 zWU)OX@p+o+sYKE*foJ!o5G&CPYOdk;LEHV(u$kF#8HuaN$Vf=kMq-|_?>ihSdjAt3 zQy|}-{?k&Be(|E}Y$l%X4qu8pzA`_z$QXKI6IT0J=Q6^VPqLe7lOnlrEWn(q>;Q@$ z51~{VDWgK@+}sK);-T|FAadMnT%n*rn#bYaDg{YxEq&