From 906dd3fb049bda4cbc6a42801b295437addfeab9 Mon Sep 17 00:00:00 2001 From: Infi Date: Mon, 16 Aug 2021 10:41:28 +0200 Subject: [PATCH 1/4] Update README to consistent format, closes #28 --- README.md | 43 +++++++++++++++++++++++++++++++++---------- 1 file changed, 33 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 5b4f89d8..69d18c47 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,43 @@ -![](assets/banner.png) +# Delta -Delta is a **blazing fast API server** built with Rust for the REVOLT platform. +## Description + +Delta is a blazing fast API server built with Rust for REVOLT. + +**Features:** -Features: - Robust and efficient API routes for running a chat platform. - Distributed notification system, allowing any node to be seamlessly connected. - Simple deployment, based mostly on pure Rust code and libraries. - Hooks up to a MongoDB deployment, provide URI and no extra work needed. -## Docker Helper Scripts +## Stack + +- [Rocket](https://rocket.rs/) (REST) +- [Async Tungstenite](https://github.com/sdroege/async-tungstenite) (WebSockets) +- [MongoDB](https://mongodb.com/) + +## Resources + +### Revolt + +- [Revolt Project Board](https://github.com/revoltchat/revolt/discussions) (Submit feature requests here) +- [Revolt Testers Server](https://app.revolt.chat/invite/Testers) +- [Contribution Guide](https://developers.revolt.chat/contributing) + +## CLI Commands + +### Docker Helper Scripts If you have Docker installed, you can use the helper scripts to deploy Revolt in your development environment. -```bash -./build.sh # build Docker image -./run.sh # run Docker container -./monitor.sh # view container logs -./remove.sh # kill and remove container -``` +| Command | Description | +| -------------- | -------------------------- | +| `./build.sh` | Build Docker Image. | +| `./run.sh` | Run Docker container. | +| `./monitor.sh` | View container logs. | +| `./remove.sh` | Kill and remove container. | + +## License + +Delta is licensed under the [GNU Affero General Public License v3.0](https://github.com/revoltchat/delta/blob/master/LICENSE). From 8ca3e50d91a919a4a1f301c72f830252a7d4c92f Mon Sep 17 00:00:00 2001 From: Infi Date: Mon, 16 Aug 2021 10:45:40 +0200 Subject: [PATCH 2/4] Remove Unused Banner --- assets/banner.png | Bin 3946 -> 0 bytes 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 assets/banner.png diff --git a/assets/banner.png b/assets/banner.png deleted file mode 100644 index 68a2bca602e6712555e4e3df301918a089a0261f..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 3946 zcmcIn`8(8IAN~@OnoQZIL8<4-6QN`a+4t-+#x{sY7~4~0P+}xwsU(%Lg@$6xSQ?CF zhE%p>8#Kl?#`0Lll7?h|z1RCUyg!`JIiGW1=eqCfb3W&~&Yf&$V+Im}3IPBBvM@Jx z007?D!?m5Dz+p@dYPong9s9@J1qA@dMgBW@fb2Jr!%ZHPgP9>v-XpbenDF@-SQ`KU zIraGNZGHead0=5|;26oX%+d~$f=RZmt!WMAT%WWA(+xq2-|2=aua(l~Uzm&iNw`Ef zeGD$=kSOm!FtP?I(hYNd+)ZBgI$F_uqgjd*IXukG%Nnj<+B$f5DQQTXR#g?1cfU7y zdW}KqRXODS)8{1*0LaMk=>tG)3m7;|P8$Jy0APNC2Yd)9|6hTw`V#;$yW!`}@D&QP zvZKdljos5R-9D^vfZFBu4s(lbRe(<)z(8L~E{9pgU2V*uSfBU#HE)0FMqczm^smiS zJ#n6vMXbj7*Zs|{xncPmd)u6;)C~%!{$Q(B!bK!Qcl*+4%v|n7uXM~#a1CZNMBHc& z$tkO?T&`v7ifj|-b@~GP$?Fk_E9|CoyIEQlW~(%hTkw%c46XX^q@jBBCToiOzIV{h zs*~fksu>%}ryq9Hz+Gy(-vS&VeVhOX zP1Kyszn2Qu93PYH&Pd`!PuF&`VUX`phJ`w3CAg9j5h`m3!g^B1CUE9v>#nTXy2}

|ZYvf~>%ujlxlfq1~V19czvDn5Rr7A#_UyTH7O zl%Kw36N;6&aA!rwv=f>K`#YBxF0i_cW@c{im3v=5y!&TBl82P;!=V6XDG?%c4fkzG z-i79_MlM)EQ4-qiYKO7Hx?jV~5pKhpw`NSIFQBE~9^ZE7`7OZ%ZXBjX)efu~3q8`- zNdyJflD^pI%D<)Tz+pqatUe)M1b>xMDmHB4&h*da(P7JomA?VO*!eWxudl8&bx~Ej zX{xk0YxPNJS>N2dv4bmYUxprfCtUh#ScBp;>geJ>`8&saY#;F+5;>@qa?U)AKAO@j z7JkI7IT$A9F#RWEc{CAkHTd~K_WF(8BM>O=k-=(dXW{O~kI65KE`5mXM6JM9E4>Ii z)ajcHl=Gb!9mDQ;C*U|%jR^{p)*!T3Icng#O+T)8{NQd>h~FB-g^Mszut`TnKw4*Ub|4{a*BktLm}mWdLv0=iFF(SiM8ijh=(7j{&z$5ep4t2c7YF4QWMli z(3-W6v94)seG^sYx1V3@wO)X%Pf(5z@!xIN^R&5?gF%E`k1yZanmo7dl6yQl&rj`v zOsx8;|0*a|uo3t%L!y8ctHK#y<9QDoW0O#Tr#KzlnQ;n1`+|uM^i26kl`X86XrXdN6CYxxmv;Rm3F~cTg(m>d+^bVkn~YIhIaRl$Z0(Jtq=xQ zVR_ybQ`0#q83TT}HrqXg=IlWRV(8AceEOy7-g*;hc0R>zvZ6_%r-gaNlr1-GK<+TY zlahVL`{}@!@xIrv7uUbs>C<{DjluZ}C@7Cb!R^>#=POCH4-5w>I9Cv6{>*q1>YBqh+Ftr99y7?nJ#tjF9uw zaWjMwab#f*-5v1LCRd*E@b`dPjAI|A0dclBr32kd2@rH&hwcf@7ck$0;bQxuj$(Fu zy;;xklG!Frh4}-4eOqCZxF_cl5`d&W)bz8`S4XqsA=0F71Mc9(f44c&-LrqM& zUDZI#XT9SXD}Bv8XvLa7P*4d@aWt+6>OTtA&{W~mFQGXK?}O;dlfA{La%B4PM{^AwB7;7Q zT8ej)uNErJ#AYftt8!|F<4gCkU zE@a}q@>4wx#$c(5A!`wFiDYxn*~U0&Qr?-|9+syY>2(rQ-1JJ%48Ae2QJySrG|^PP z7qwYX!PX7e=2Z}kHBX>Lor4BmcT*+xHT>qjd|?s6*-Jxm^`>|EW?Z>K4G2 zbPe1LB^cBQ#Mj7U2W0{f1E>79@G}H#vMBCbI;N{AzbcD~9*Yp8>%|N(Tg4wipt6s= zf=ed*5fKar5c(WS?6WcA4sOQ2x+^8nJX>jh$+`Vk>yn83dq}5$q*SgCwQF&$cU9q@ z)c6JJxMAnzEsYDVx<$th1n^}<6k^4F@j=i?lvnN#{xIyJIMvIWZ-cds{lUNGWzz_c z?2nuxMqXME$PgeqnyqKz6FSvG@W=v^zIw^uL6XdX>W~iX%*gdroMc|I1af3)YPCve zDY3Vv+^q2|uS`PRVT0QJ?mwI3>Tv!YuGU$cnLDfA@#lClIPQ4G`fZ??j`a{j8Bbo+FV~kFct!WamQW?;aXos zlp`*yXP>i#Pu;GU2_YE1U8zeZ2X>7>I72vq@WZ86h~TSJn&O!c((8G$kbs^JCOfkc zBeAI#G7xFbOCcjy%PvEf5$+qaddyR`rGJk@c-jelP0=Qots4URyb$x+X+m#c|Wi8pUr^v|7F5s0}s zLiGz5tBGr-UljlszI&1$4ywyceELFmdT=&4;O>aRbEp~Toj{`!e{HZ2y6g!NLpHcJ z`$h{XI(lNrnuHNj7)U~C6j>NLx&E5--ePM>Scl^?p^0|$+34we6xj)CQ1qGWP}9DrjSMeP~M)#$TL@#8Thp zI32hT)w;F=^H=2lZTmcUY_QepfsdMP`>hS9row4tLBE#OzxJ8qa?F*$dwY|82@7J@rP54P72=SUW4>iuvDeL1_pJ*|@0t5+0K zxA?q~ao6)BhOIi#q{Mjmly!Ah3cTu zXfa;26xOD?T`}WNA}>kYNafP@rrUp!3@USF)%j5kS`#t6>Eu8Slo06|C*?ij=b7J|+UG;Cr zi9p*27f_Sqdi-GiO8W1w-9P8t1-0o@oKvga9v*3%sR6l)<iLn*P&;>+N5$NG?TENZCsr#wgsq!0biaQ4&vcuB6~FXko~+S zp%=uMR>!Hal*igdIf~^zi;>*pRhOlLyHhk3zj&Ul8~G?lpBsm%70(p>8!}cPi&Uhg zeFyXNJD`I}#A0^i%S3$^VQ+81w%F(4MrcmO$L)OPJGO7I<%z@ZYM_DV_{es5f9q(N zx+i?BM@Bi@@g#{L^sc>e$jd#$7K9(a0&QWS9$7KdXa+(li7@@B?FobBtOl*wbNSIu zQq8RE^O?9~j#ODuoRj@2r7zjF?3!~y8eAFZq6K~RAn&M7Qy@*S+mg4EcUE^&_=t(b z)xkLE365bK5-0-s4Ts}x;48#I`mG~HNUv8n6Jl&{8)N*zG?YWa3wl)XL~$=Y^c?1) z?5=dW$P@2yoE%Q{Td0&O*F)nPKIHF%kq=Tvy%wn@b5bfEPN@~l*$Owpv`b=I9kGth zXf!`nz-|BjL*U>Ijr+|t0}_|g4zJMdjXk>%vfY61e}83r`Xb0#xvjS@0nw*_pOrc| zXO}2{6zwNz8!~pR1&wj#kk3SyL0~RJW#^r`y GasL4@-gZd< From 7c7573d3cf6471250dc3a19aa2df3e700948a1b2 Mon Sep 17 00:00:00 2001 From: Infi Date: Mon, 16 Aug 2021 10:48:09 +0200 Subject: [PATCH 3/4] Fix Naming for Revolt, replace mention of Revolt with Delta --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 69d18c47..311da649 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ## Description -Delta is a blazing fast API server built with Rust for REVOLT. +Delta is a blazing fast API server built with Rust for Revolt. **Features:** @@ -29,7 +29,7 @@ Delta is a blazing fast API server built with Rust for REVOLT. ### Docker Helper Scripts -If you have Docker installed, you can use the helper scripts to deploy Revolt in your development environment. +If you have Docker installed, you can use the helper scripts to deploy Delta in your development environment. | Command | Description | | -------------- | -------------------------- | From 6d2d3003bd4f40db0243bfbf50c47dc0e3521f33 Mon Sep 17 00:00:00 2001 From: Infi Date: Sun, 22 Aug 2021 22:58:39 +0200 Subject: [PATCH 4/4] Implement requested changes --- README.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 311da649..249a2c39 100644 --- a/README.md +++ b/README.md @@ -27,16 +27,18 @@ Delta is a blazing fast API server built with Rust for Revolt. ## CLI Commands -### Docker Helper Scripts +| Command | Description | +| ------------------ | ----------------------------------------------------------------------------------------- | +| `./publish.sh` | Publish a Docker Image. | +| `./set_version.sh` | Update the version. **Not intended for PR use.** | +| `cargo build` | Build/compile Delta. | +| `cargo run` | Run Delta. | +| `cargo fmt` | Format Delta. Not intended for PR use to avoid accidentally formatting unformatted files. | -If you have Docker installed, you can use the helper scripts to deploy Delta in your development environment. +## Contributing -| Command | Description | -| -------------- | -------------------------- | -| `./build.sh` | Build Docker Image. | -| `./run.sh` | Run Docker container. | -| `./monitor.sh` | View container logs. | -| `./remove.sh` | Kill and remove container. | +The contribution guide is located at [developers.revolt.chat/contributing](https://developers.revolt.chat/contributing). +Please note that a pull request should only take care of one issue so that we can review it quickly. ## License