From 0dbcfb53855336dd77d6c1ddfae88bb8de757e8e Mon Sep 17 00:00:00 2001 From: Trevor Blades Date: Thu, 26 Mar 2020 23:04:50 -0700 Subject: [PATCH] Update readme --- README.md | 16 ++++++++++++---- logo.png | Bin 0 -> 9472 bytes 2 files changed, 12 insertions(+), 4 deletions(-) create mode 100644 logo.png diff --git a/README.md b/README.md index 0608aaf..85595a5 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,27 @@ -globe +

+ globe +

-# Countries GraphQL API +

Countries GraphQL API

+ +
[![Build Status](https://github.com/trevorblades/countries/workflows/Node%20CI/badge.svg)](https://github.com/trevorblades/countries/actions) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md) +
+ A public GraphQL API for information about countries, continents, and languages. This project uses [Countries List](https://annexare.github.io/Countries/) and [`provinces`](https://github.com/substack/provinces) as data sources, so the schema follows the shape of that data, with a few exceptions: 1. The codes used to key the objects in the original data are available as a `code` property on each item returned from the API. -2. The `continent` and `languages` properties are now objects and arrays of objects, respectively. +2. The `country.continent` and `country.languages` are now objects and arrays of objects, respectively. 3. Each `Country` has an array of `states` populated by their states/provinces, if any. ## Writing queries ```graphql { - country(code: "BR") { + country(code: BR) { name native emoji @@ -49,6 +55,8 @@ The above GraphQL query will produce the following JSON response: } ``` +## Docs + Check out [the playground](https://countries.trevorblades.com) to explore the schema and test out some queries. ## Examples diff --git a/logo.png b/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..ae2b801299c692e6d8070443a8b86610a7883d4d GIT binary patch literal 9472 zcmV+bCI8xqP)4kS;}vbfow5&VP3I`(}6V z?9R+ipE>)xJ2Q7??mg#!&zZS%%egTTkxd9tbxybmhl0emE^ljbsHxgkbrbd~dY`Bafau@-MG4Qu=*v=ta zAw}oh#|LGEvf?uHANi1JI*nl-$DyfpSOum-XK(m!NnlDZV9lXjlU82fZ6APp|NdV7sCezLKiTIuW_jF zbuc6T3?aasjN&>rl8+4CPhr^2DKz1n8Ib7XB2cu{8(4%h< zs>|R_<#4HYxaTqDZU|fqb=dxFHz%vqg$UtZ?qw)%eXs&^0)WdN`Q1+|?iY_>w zxhzAE7zmAG=0TNGy_0?+~01w|)p%tl|*E-NIJVm8NfxLF^&!Mmy)PdRGT zNQedv*wY-({@%tt16#NO^v55CILV`#LQa!d{{H;jJRU+Es60O@o2_U%M3zf9DlNBHnb(+TJZ>q@8yerst#8W4dul#(Th1`HtDyjf}!nvq|8 zL3HuOp*9rg3Va=hffVCl-?8B;@R~J==FHKw0bM6XjUp;hB3!ts^o0Ek2i{1OYE|go z90dhLKm4G}26A46YFX*hp*0fdPEe~`_#hA8H%FB!M1_Sp_1@406DEY#Ku`_GHwhYd zf<`on1q=LlM!Jk|zG+DJbzh8cne@Cubo_F_tOIS@;VV#lSldNAb`Vvo7CuZ>dc-;v z2tu!DI13W3Pj=E@{t`}HRr-X{7q*hk9fiuc8Vnz?IUidwGL?Ai)t`m~U?Aduxxl)Hz0m4AG)dU0e0)%z&^hRyrDU;z(1pz1!Z(RaU7`RL=u^{b$J z_#T0qC`-s915q4-!EcpA6$?vbw>6P9Yiv!vC~>FqDaz3MJJ3PaMQfbXS!5t$7&Fz) z``9_h;l_>j=Y{@{@4vS{A0OrbU4%}0f#55bc*a-gdv#e|iQ2RwdjEYp`_EI;K5~TU zsi%mlR*mpa(?RGY{5ZQwioaY8K~|I_%-hgmoV}TEhhsp_jr6{+VYI&7ZGd^{uRSojiF`cgDzf+&Cgs|H4{U z3AtHU9VKN=Kz2$KF5nwBB$_md$bgR0JMR#+YDF|+!93lHt##o(+DAQi-%OWZx1Uz7 z)VeA&9@W1gLx@lv3|pBcAQ=x+E}a zx`xD|a@3oDJNajZ3aOCV@=xG5<}PJk`aSm$?b@Y3HB<+$x+*;7mZqc7*^&;tN0eoL zLtz}T7*U@-L>o8iSHhouiu=4u@jf!+cX7q$|7!dj!9TnW^w2t5N4M~=B>xoS!2hvQ zBw8<3%AiIKqUWC{I(AG?YVm7OJw!DzO@YF2%u7_;N?0g99P5yudoGcY8G&#BH(~@) z<;rP_*Zuus#a8W=qjJ<^`%N_NrK2=^HW6B%V2EFTP4w=&L{B_HboL9AD8|1c!%*+d z?vkR=EnCJN(dji4R1;BMM71$QhJtn6S%+;SdMM~%Hf>5YeY##Xi(mKp>qLzkOBAj2 zQ4-5rs?|Dmzt`*8m9y+&604f0-lIOcW_rf`UAq!3S)!kRR2xx!L^U$#Wt)(Xb=Vf7 zN}R#Ypn?eZJaEi*_^^KE`s_2J&YiO;)_qT^)j4&4-Ua#;vd7HS`_xD4Pa#qMU`9Id z;CSn;L|eD&mj!PxR3}lb3~CuCfE?Z7CB#6L4nQps{XxldZ%Cunv(G54`P^S8u zN$jnxR_EgVTWbX6`s{_7pa6!4cT zNgOFte7|~+TgOC`wOP|^(u8Q*H2n_%T#0HXJVKf&bG(I`H6v=@o~UC-B2-&b8ZF${ zBj_^gv}HuMn*qwId)l>&56D}wLO#|BPjo22WtZi6swWEO)KlXh!g^Ka#0jE_6Nz*i zW9J1VPHKEyZ?8q7`Yz*&_m>CMW|6x8_T{?LLv?V`BE3?_-#n;xqWYPuEGt%wj|H1G zOFr!8;6Wl(Ne2xgs#`aAdb#qm;5_TJB}6i%y&(3LKp z?l;~@golb=LiH2XP*g|LWyTx*vB!+{$Dm1i%ou%!m!6-6$Ixjwe8`vR77Llm09Y&S zVZ(@y9@Sffnb*DgYViT`?zpNDrw3_Km8`Z?&!-@9q*FqpO{=4spP%Ta7(YiI!x8G)7r#EKH7FB1e zPQH_QTeR()r*$Z6m9MmjnId4brH8sI#t&IRa2k!487RA6f)T-(ObyFG)oDk~RK-mm zp~}^1p)L%v;UngsmrOBpJLDpPoXr_M{(kIvUtS`$^Dti06NnY}9at55S%wB#f(Bj0TL z5YK+q+iyFgYiZa*$64166ZKC^C@;`+rFG|>*}=2&EDRCrYsgwB}Bc*%|}BJTt$>fJA<1^}{q`BLgAxDJN9h@Zql;0~s#n;#k)W6U}#uQ8YbT zwM1FA0>Us7z3uwCWzW_8iouHJ3N8D6XbtvEL)N-;|M-V1 z2Ew{-h^T-I)v*atcxpI7qet5Sezp$0w|ZKpq*5dM^(Wc}f)2@QyDiP%$RJ3w<+*8- z4P})3VE|ocozEn#CaykwX)N<{dty3wwkO^6RGT(UkID16`D!5sKO;}%Fpp%=Iw!xw zc+%)q3cp0vl)nO+@vSm zu3dVJJ;!a@Se)*2_Xtt;h&<7!?h|6I0~$4yS0dZ5F*x;)e-ok|uefaiHEt|KC5>z> zNIoTrwrx`mojTBKAk>LDYVH(Q$ful@!^W~OUfs&2=r4Uwh#v3CbK7u=5F_uGpR+o4 z3wzppOk;{e$rD06f0rdWRpnFIS~R6&=jINQi%3U3BQk&QX5C+&xA+t0(^? zM1_Oe=XIRfyI03W7G2_$K1kTjrTbLd$=0i6%M8ZiI6+gUSkOY!a3hI*mE^5QaHi0v z(9)KpBu2WnD(4UxLs9-bEN{NxkirRqBMM#e=5C!bnhsjC*anIz{SCs8Kj&Jnl5BkT zSsae!v0dAR3oS?)AK#Vs%M%*QQw)|`-4Yk$tDpngtusBKo^amP>Qz+WTz6s8QV$p0u7!=gpVDIS{+8w&nc}rpn^+ z2eo;`)Lkvvbi_OHrhni8*WMmUY`E!9lZfrt9R{zz-d+QlFdU;1|7KKDX7zla?=GB1ALeADU@B3izj z2-A1-Dktl3lyw@?%U)panrq~a8O#>RYp+=V`rig(q(6NzJAFxz1x=I@~zfj)j2-0Q17OkU~oTho_i4 z>n!t6DL5j)s!x`H{>iVCDwVk%^o%um7%M#ed15p#M)hj_Fd8_Iyx|VW=yDKhgTc}e z9$vdd-5)~SgJ_XLS(pxH8KT)wuXlB{f=r!C)Tog~vfMaDOSMRRe=3Pm$MRAzM=<}x zKeT1Qe3E>;tR%`Bo)|y=Sgrcm_u;(}P9GeR-@HDmd(~->mzgbHnh49C!FijEFzFwD zo2pm05cEp>NNj4Ltz2FI>-7ST^9KXK3`4EoAIDiHNAu=!S3>{(cYIzu9AjhJF1|57 z_#o~-E2}SK^U7?Q3@STdnXT3a@FY_zfLe3~}fhM*39VcvEF!HQ0+n`tZ2m2dc4 ziQs++K76%)*Z-ft<+I+vJ7BnbK~YUB>^noA7NXf2ISRA83i0NZ@^gNPJ;qb@?s{IE zTTHCd8p^MISCG#Xz(AS=Swh{i{bHjK4~&pse!Nt6#ggCU&Dj6`Mu@krkn`4XlMoL+ zAwL(+*d{QLdf}8kP3ot4Rj!H$(jpUwaD1@rRQWkS#$w7a+!DzMldiO;6U(j-c3eFe zNX=l&s6)C7J`$prh7aSdb%l8JVI7J1=#q6!gcvnc&TuY=6!N=*8e20m5V*$q>z&#K zeE&!x_Eyn8@7FUhkoAq_+{2~OWi#dH!WF9+NUd!l>%u1NOVUy%gd9A#IcAfIR35VX}V09e{lc;=Vd z6QOojBT;)>kPALlwrB5=nMXYCwce@MhRaykHU#Ysoq@o?!op74N^#eia4ALAJtVf) z(Z=KakHUpV@k4-ZLlFC<4B1$$ne9J+=)& z$NeI>B~`4-dr54mr>zVZeHcbXh`TLXbhb7wx4#fZT-Y|kW*|@BtE~jnuL+|P6w7?} zBJGJ)XzhdhBkw=;t>jTLknmKoS}h}Sw6xqn4pbn~XoHpD`ZKKwx5)89?2EVhQzr99 ztyHnX^N~KQn|9$p_;}a~UoLN*tt9qTmE#2WM`wH`zt6l9dO1DiBRw3=yglEN7dm2p zC?HYpke3U}S>En`P8+KQoxSB|)n3C?nt3<)rCw?JBOS^QBhdO?{9zhbEEGSqWmFwDp>q-MN9d)C^kOY7o&b(a-Bzyl`Ov@^JGkW$>olWmRgp`&=&+seT%UMr-7BZsvb zem%O+65{e1R^;N59j4j(ues41Jcnxh3NEY=Jjn0MZtqpMaQMT7p+^f z%TD&$dGx3dhq#}%uuzCk`Ia>ru8%Vlb3Fz&ktFXf!G-~fPd`nxXODb!sbuWoW5;MZ z|GM%oV^~SJ9S>OlR!MVsQHILUZTwrvzg&dnqwlzb2zZHu==H+zAAbp#Nq8VF=bus9v4iO9t37QbDT{d4_L4O>X+ren zmqsB^y?!t4r7rx7oS)gGgxnhV@WBzOpqn_t!mMS=*u-PT0=UVjH{KvBS<+KR!nTk>^s?KEgnDUVp-GfA zZaZ{{s9ifxf$w|6!#9N0^wLY7DkHXq3?goxaF}R$C#TFDn zRR*FQ^9&>BsX_%_;Hj6r`8I0AYrKo8qB*B* zc<0gNf!*7M3+>J!o_^sg9ayS0&SVy_Tn@85Yi6GiEehe5Q`VP0v>cegR&XO zBYd?ZUk9ImF2rFjfpY9&#!fot)T-jtvQ@>hWp?Hg%(Tmt5n}UtZsaYnSH1-cggDMF z%^W7QUP%o^QpEymv9$+j0s$57so7g#qpMBOo@U>E2wTkG9E1Z+jNj%Nw z)t~_pCNiBosfC*L@yM%NH&@C5I?lRoifEcykj>nOk(^(DZ9VvUQk*xBs6z)=3dj?0 z3zQe81PmWew12-I#H_vM$tPXIo^{+bQ4ceUp3gl61s2XIJVLZ+k^X{26%S8N%xcU> z2EW~lYRwHd5dHXLZmjU6pE8BW>KTRbLEsW@tmCGM_#>Wp_^-3f*Q-bL%{RFVE87*@ zw-a4*Nt|!Iy1)A_+tsP(@C3z^w0wDI<#rlp{yJ+!w;Kt zs-aH*#TSW6lqgQqVGN+#8VyytjfVO<%(U_(DOZl@(MO36A6CPuZ~wjbh+t%DzA@){ zzyP9c+w`S@t2S(iKUrP+a7^J}EsGWVcvDZCrVooBejvK$np8ZKJaq0%w0gC^bktV? z+pDgUrPz1LyurgoB4|hs>9y~w)Of+;TQLb5jrAiU??oIUBXPM=a9)oYpyYKddUo7Y} z>vndEWj~!fOSkhL_a3-MCAkB)V@F={qm2-)S_y%UD~#FMxl@Qmi-h>%3n9>-qL&H^ zgn05vUV!Rqy>|#Pok!{n9m?xPtkZvwSFQwp{rU;<_~SyKs2*{WoN4zn)XLiCU- zqrd{%up!ap$;Nt;-+70qWlLj9hUU#qorrF_DgH5xs@tGJM7??uVd#xftl`2F_hT4M zE;@3AX!K~JYSoPAW0WtCUC&=uwh>ihVR>PZaDa-jNb~3CQnljqXh|D0hNwo3?D({8 z8}E?J)#SW*=L8lOwx1`I?B503ehcT%((q3btQlFAq*Ty zggyngXzf~}Yp;zAL!ytYqplJ0ST0&1VagRnb(@c>RpSFI(Z}Ev?cGas|NXfK6uOO# zOZh`Lb&fZb8&O_2$CISfc*`vW!l@Plxg;KnZPrYPi4%o5|9pFyg2O#58Q_#(F?*%4 zJary&iKWeBc{vfvcd`icpfK=|<>L7`L97Li(ZzNXMl?I+_}gw-Y)GGVGC$)0PZk)6 zBH9T4|3KM`{uBf{u#Y+?$fYQ2dDCJ zMjA_Ufex}RDms~Wf)*JF_=s)ezw0=l?iYH>H7Us|fNH0&=51BN{!9nD$2zF!q9qbo zXdvJx_7VR*Y6)jPPXx2*oS@yioyf&Ed9dy&I%pZg78{7d*Pr=+wq+dpG@;F#onhRm ze4LRcuUw#W&^=4Z1_OzmWDalS@ROyS`Yf@fOPyi3u+W)&Je~`5jdf1ZJxf`&!9c)Y zY%Bj=&*2!3!bme_*e~^=L)>&2wH-poSl1MtvmA7r3m; zpZ^&1sze?yh`p?>BG!W>J*3yA~w;C$X!i92pe9xZxrpab|lfb!KNWGCHjRU&F zIuvN4>MZ0E4oRUyv&A&s1q-s7fc)I?<8cQKa6BDG+!8WFXIOVaL5h)t@=b!mhNly( zwUKL0Myylv+G|9uTZh^(@KAuRxMCa@Oqeoj(aNjxpL}-@vnlxfJ`6OxkCnpSIXPQLq50gc+{`I7UIJXWC;pAO!)|3FwA<#sO|zeuJn1QF=w6 z_7+cS{-S+{5a4eP!OIiGo^dF@tl4sx}%AM;aiCz8%kwKvVbUL4zEjt^<1rh<2HJ7=!i~~q}&_KYJ zGPb`v@38BZXpTD&2`FI>Im(#J+Mf9w`QqlmDptBkbRox}%Edhe5d{bVcppKPYMz&6 z^5`2x4VeNUs$3taW21dvBY?6*m1>^XrSO4)07Au$3->vT2RTG;g#d{^31x>e_X>R2eAxbum2atOLYdPP294a^z)h!X&iW-vuS1V`&&RS|G)@X0W+VBypR-o6lDehVmArY zpTm3(QC~{&!va_U6JWy_g_ok<&7!iW0^aSD2+fP4!?m-T#hnrlv9;k6T`p~8AW~eY z6Gvamp$mt$9D<4ySF=PRhdCUkvzVXqHX;=QK`nTdi23dkd#@4~akx0KWiM8~CjQVC zb2)q%-^RB4S{j>~j|{{xz|@d$fw3eFrm^89oV{T^XO}bxHj3CLXS4TrZjpiHU4F_N zradQv&@QpXH;mICw?A{9_=aE~w&J_QmiMDK1Y=>EA_FlEU9KAyU$Ra3ssaw!!b?ld zM5vY6q6fN6B9u*Rc_WT;IFi_6e?JEv&LMUrw%GrP!#WOY