From bc48785b2347267b5c37deb5e18d036d7fcefab4 Mon Sep 17 00:00:00 2001 From: Joe Nelson Date: Fri, 18 Mar 2016 13:32:13 -0700 Subject: [PATCH] Readme for 5.0 --- README.md | 85 ++++++++++++++++++++++++++++++++++++++++++++++ github-banner.png | Bin 0 -> 4139 bytes 2 files changed, 85 insertions(+) create mode 100644 README.md create mode 100644 github-banner.png diff --git a/README.md b/README.md new file mode 100644 index 000000000..476d96698 --- /dev/null +++ b/README.md @@ -0,0 +1,85 @@ +![Citus Banner](/github-banner.png) + +![Build Status](https://img.shields.io/badge/build-passing-brightgreen.svg) +[![Citus IRC](https://img.shields.io/badge/irc-%23citus-blue.svg)](irc://irc.freenode.net/citus) +[![Latest Docs](https://img.shields.io/badge/docs-latest-brightgreen.svg)](https://www.citusdata.com/documentation/citus-documentation-5/index.html) + +### What is Citus? + +* **Open-source** PostgreSQL extension (not a fork) +* **Scalable** across multiple hosts through sharding and replication +* **Distributed** engine for query parallelization +* **Highly available** in the face of host failures + +Citus horizontally scales PostgreSQL across commodity servers using +sharding and replication. Its query engine parallelizes incoming +SQL queries across these servers to enable real-time responses on +large datasets. + +Citus extends the underlying database rather than forking it, which +gives developers and enterprises the power and familiarity of a +traditional relational database. As an extension, Citus supports +new PostgreSQL releases, allowing users to benefit from new features +while maintaining compatibility with existing PostgreSQL tools. + +Common Use-Cases: +* Powering real-time analytic dashboards +* Exploratory queries on events as they happen +* Large dataset archival and reporting +* Session analytics (funnels, segmentation, and cohorts) + +To learn more, visit [citusdata.com](citusdata.com). + +### Quickstart + +#### Local Citus Cluster + +* Install docker-compose: [Mac](https://www.docker.com/products/docker-toolbox) | [Linux](https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-compose-on-ubuntu-14-04) +* (Mac only) connect to Docker VM + ```bash + eval $(docker-machine env default) + ``` + +* Pull and start the docker images + ```bash + wget https://raw.githubusercontent.com/citusdata/docker/master/docker-compose.yml + docker-compose -p citus up -d + ``` + +* Connect to the master database + ```bash + docker exec -it citus_master psql -U postgres -d postgres + ``` + +* Follow the [first tutorial](https://www.citusdata.com/documentation/citus-documentation-5/tutorials/tut-real-time.html) instructions +* To shut the cluster down, run + + ```bash + docker-compose -p citus down + ``` + +### Learn More + +The project +[documentation](https://www.citusdata.com/documentation/citus-documentat +ion-5/index.html) and +[tutorials](https://www.citusdata.com/documentation/citus-documentation- +5/tutorials/tut-real-time.html) are good places to start. +We’re responsive on Github, so you can use the [issue +tracker](https://github.com/citusdata/citus/issues) to check for or +submit bug reports and feature requests. For more immediate help +or general discussion we’re on IRC at `#citus` on Freenode and +[@citusdata](https://twitter.com/citusdata) on Twitter. + +We also offer training and dedicated support options. More information +is available on our [support +page](https://www.citusdata.com/citus-products/citus-data-pricing). + +### Contributing + +Citus is built on and of open source. We welcome your contributions, +and have added a +[helpwanted](https://github.com/citusdata/citus/labels/helpwanted) label +to issues which are accessible to new contributors. The CONTRIBUTING.md +file explains how to get started developing the Citus extension +itself and our code quality guidelines. diff --git a/github-banner.png b/github-banner.png new file mode 100644 index 0000000000000000000000000000000000000000..d7818f345ce4be5c3c9a2411e9e961b21cdab762 GIT binary patch literal 4139 zcmV+`5Y+F9P)1dOVH)5R* z{0sQ45{M<@HK4WWbd!#k6>CWqkV?cmK*Or|#4hu*qJefmXBTt<;`yCAKu6(uC;GjX z%0VJj1O%S8dXvKgLw-PL?Q4x5K|L7a}==ELGbqhZvl5l zrRVsg(sBj^-GDYgbfKr`)4et^&$H3+t~ii{iyKq4D1R3IZp zD}E>55X=xvr{NU3R8ZFFO#iB=KG;)9(n*U(bO52wf)L#fyb5dqb^$wpO}q*$2JQzg z0(v2TJ%_s60iU}NYK`g4SPdZ8VJ6mY5Njd~6wv~yx+E>gngqdl zn*}H+OrHYtfUAMifs>K1GYEAe&Eh~?po8m*=JStqAy|GGBp|c;nZTcb3xE;8sX$x= z2-aFbur^gpbn5RjfU*3YnLq=NazOE;-FYm=F`0T>zlTdOpFf_%=xAGTE?WazMvP$g zHmcuk3Y^B4(6PK4o>r0PBF4 z*?2-~-~eE#d$59(I#_rRZlHzd!-a9Nu)+xUghh6{l2G~T1gq^mhdU3~Uz zD8fu0@E@TP?u+V`JIqF`1guI=v(NwE?McwTG`g&dtQ>1cd_kTKl1Qx-&7!3;5gBy5PXvE1oQc4 zhT!ikl>9b|%iEw?#^<&+OpvtI4YCPgu2(^h13rS;eMfYr|CHd*Nef4eV<8F-%Gb1K z@u0saa!A!^)|FE{h0yr?GZY`a9&L?rAs2-#EeV5MK~N+|bKb)^5$s9L@(S3p8fk)E z?D4xcV|>fi|MVPE$yY@vob6bG1y-X-g~|m9_PJ*Mot%G&hv*|WcqZ6fbnx!ze$Y*6 z)ml6}7OU3d!hpO%#tDtGdH~Z|Uo8+CMrQsGforsgMlJ!_2d2U3;=X!a?;u771N_cOyZN<(9#uFL%S$`*j z*~%dGZ;zzjCPKcR5hj>S6&_@Jw?0n*8!AkcnO0wKlZ+9~_*0~lVIV|lw+6v(SLAsG z=%}zRE_9HaF+%>+BzfMJ?7L)TePUTfE4HB#a8LLIqp0Id|9Yr}meuT}=Z2@SVA%)h zNsV$Y=8b8o=H_v`>qaqPzODFv&&x(}Thq|C779VUSt4vDc7uR}5GMn{Lq12L44Ls^m}0D^x{OgD#R>I%>+D{@8u_W@`NxjIz&?K+g>gYfFn33@ z&%acvI?|rg`THIYmtgn9pfR3Tt{&+8uY>_wq*2CA9u7@TXTM5QD+bZoM883z8qTK2 zo#u>8fNzadz!-@T#sI5Tv4Uavm8vVjf_tzL3Kf^?o)4rt^!Ied>|Q^_eR4jNq+^-O zryM0#?5TUXT@?lfZv^xCn=8WaCTX;x8L%rfg8BTZFvU-0V@7-EX2OvZC2s_b3agdf^i+S+ZX||-|!#{&qRP=JtWV!Xv6>OA zm!zF;1e2{$mk4y=xV$#tHj^Y@5CBdN5X2cN+s8XwWXip;3!rznU@&CMzko&{O6 zSty-^Fo7c?L^F9xH6vJ8URmw=esGE8cv&)D7bx=jfEScR%R}AsMs{W&*h`XeyIxZO zQzR-_zAdIzwzsRNS@yCB5UiWz1U(t#T4=W6(UA6FWPyXg?vQl;!y1)d<$+-9m4TN5 zVvS~>S;d2#sk!}aPVZc9-{UUdMQ6DFEBUUgsu{r&B0spO%3B1{^xsQU_1qr;g0)eEMxCqChPqY&Mo0w9%eqq$ zgO{dJ@wFa3-+5N22COm^>o$-bmn!Gq8jvf+My{bOq`&B_M07uf!nqu;@h%18cC7+} z#VRI(@rrh}k_7M;i~S+fJ~*o7F|jWA5tmsRQgg>C+$qCdhXS>G{}*%n`d)Wjqin9veb<$q_!hxz{D%V;JyQ8@W!k z&GZjyt~P@edyltVRIqs7=g>tpH`tHVM4Dinccr9_8)Vj7{5DgPcQ+X}YO;HHo3Qe`3MI~G?x&?!Lj=dU?i{kaZutlyXXc8=1v0n*V(Qf1D z_)ZK890_zLYda+#A~|#jM!v8w73IAL zT*T)5MAohzatQ^S>m+3ltU~S@iTu;4;14>pivy+3zAuXv*bKj zUEcHP3h|2^#V`JTwj}7dqLEB>=}jQ`xLC6dudoU!{yyJH;AXfS25c3QBnJ-bjpaX8 zw2(V!2_He2!U3g9{}t4gMtsymY}2(-VJ3>6=RMX|4dEjr!E_06PU8rXql_Z9Op5th zv+<$GmbcLDRw;_E(3l8l#hj|T&xB7&FO@j3?Rd@gux!Az{g_Jt_bOiT2D17XL=pSC zR96O!cRAF#i;pwK@ZUTr7Rnwils8nUznDX;VjRAYWbs`W?dmSR4|JZ;hGNSB?l6$g zx(woks47nEtJx^q#7FW@ce0SOsz;agJj$_o^EvWi5*t1mDc+?Cpf`n(@xOh59>L=* zwtRJ2&{J*sDQcshM*Cv9FK#4to!d8$jWVMusC4RbsNO5+u15a8*-XrS9w*I2j>dS1 zjSq7;PSjWC+YAJ5r}AYuy*a|Zn~Q+QaY)=Pmbw)vdnR9g6K~6x#CLeu%Wf)^)mT!0 zvc|W?SQb*B|3?0<`8=sydQ6<6&)-SXh7L}hzg%MmZ&5|WYR~=|*^HYX@@i_5NxxTO z{oPGXdPOypN2m?)tg@-BeDr${Gg>CqM1sxG+z8Wg^KKEYnLUl}1U_nU$fZ6Cg&Jc<$)uW0uw(~6mzccpUN-4? zC)o)cAi6P3Qhm$eSQH)J%=D~DCLK$(IvmkGjsF7Uc0OlR%ttVa_`i?vp~%f_k-USi pZ#DtCCYfZCNhX