From ddd16648f9d26f7a73eb164f1e13b52e7e91d6a3 Mon Sep 17 00:00:00 2001 From: FRACerqueira Date: Sat, 22 Jan 2022 09:23:06 -0300 Subject: [PATCH] Updated Readme --- README.md | 55 +++++++++++++++++++++++++++++++++++++++---- docs/images/icon.png | Bin 0 -> 4660 bytes 2 files changed, 50 insertions(+), 5 deletions(-) create mode 100644 docs/images/icon.png diff --git a/README.md b/README.md index d71dfc9..78bffbc 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,30 @@ -# **Welcome to RingBufferPlus** +# # **Welcome to RingBufferPlus** +[![Build](https://github.com/FRACerqueira/RingBufferPlus/workflows/Build/badge.svg)](https://github.com/FRACerqueira/RingBufferPlus/actions/workflows/build.yml) +[![Publish](https://github.com/FRACerqueira/RingBufferPlus/actions/workflows/publish.yml/badge.svg)](https://github.com/FRACerqueira/RingBufferPlus/actions/workflows/publish.yml) +[![Downloads](https://img.shields.io/nuget/dt/RingBufferPlus)](https://www.nuget.org/packages/RingBufferPlus/) +[![NuGet](https://img.shields.io/nuget/v/RingBufferPlus)](https://www.nuget.org/packages/RingBufferPlus/) +[![License](https://img.shields.io/github/license/FRACerqueira/RingBufferPlus)](https://github.com/FRACerqueira/RingBufferPlus/blob/master/LICENSE) A generic circular buffer (ring buffer) in C# with Auto-Scaler, Health-Check and Report-Metrics. -RingBufferPlus was developed in c# with the **netstandard2.1, .NET 5 AND .NET6 ** target frameworks. -## **Official pages** : +RingBufferPlus was developed in c# with the **netstandard2.1, .NET 5 AND .NET6** target frameworks. + +[**Usage**](#usage) | [**Install**](#install) | [**Api**](#apis) | [**Supported Platforms**](#supported-platforms) + #### **[Visit the RingBufferPlus official page for complete documentation](https://fracerqueira.github.io/RingBufferPlus)** +## Examples +The project in the folder **RingBufferPlusRabbit** contains the samples with RabbitMQ(publish). + +``` +dotnet run --project RingBufferPlusRabbit +``` + +## Usage + ## **RingBufferPlus - Sample Minimum Usage** +[**Top**](#-welcome-to-ringbufferplus) ```csharp public class MyClass @@ -36,6 +53,7 @@ rb.Dispose(); ``` ## **RingBufferPlus - Sample Complex Usage** +[**Top**](#-welcome-to-ringbufferplus) ```csharp public class MyClass : IDisposable @@ -82,8 +100,8 @@ var build_rb = RingBuffer .ReportMetrics((metric,ctk) => Console.WriteLine(metric.ErrorCount)) .AutoScaler((RingBufferMetric, CancellationToken) => { - return 5; - }) + return 5; + }) .Build(); build_rb.AutoScaleCallback += Ring_AutoScaleCallback; @@ -116,6 +134,33 @@ private void Ring_AutoScaleCallback(object sender, RingBufferAutoScaleEventArgs ``` +## Install +[**Top**](#-welcome-to-ringbufferplus) + +RingBufferPlus was developed in c# with the **netstandard2.1, .NET 5 AND .NET6** target frameworks. + +``` +Install-Package RingBufferPlus [-pre] +``` + +``` +dotnet add package RingBufferPlus [--prerelease] +``` + +**_Note: [-pre]/[--prerelease] usage for pre-release versions_** + +## Apis +[**Top**](#-welcome-to-ringbufferplus) + +| Api | Details | +| --- | --- | + +## Supported platforms +[**Top**](#-welcome-to-ringbufferplus) + +- Windows +- Linux (Ubuntu, etc) + ## **License** This project is licensed under the [MIT License](https://github.com/FRACerqueira/RingBufferPlus/blob/master/LICENSE) diff --git a/docs/images/icon.png b/docs/images/icon.png new file mode 100644 index 0000000000000000000000000000000000000000..d43362b93b6f4a718c89bedbca78ce92174190e9 GIT binary patch literal 4660 zcmV-463gw0P)Px#1ZP1_K>z@;j|==^1poj532;bRa{vGi!vFvd!vV){sAK>D5y?qJK~#8N?VJg8 z6jj#8|JD1JboPa;AYlm*CV-BtBBCe=Dgqjv8BrORGdSR=%qJ+EgJ;g?H!7eqG764^ zjvye)qJlFZBa09ShOotiY$POP=`7vpy}RmtRZRsFNLP1tcNRVQaq3jvSKVFj{p-G4 z_q}=nee}^sAAR)EM<0Fk(Z??v#!yZeQ#ENNg@iBq*+B98UIDQ*5ynt~)=NJ@SMqO2 z?M6?zv8EI*V*|omO+d~oI6iJG4CZP`=rF`;GoX@(c|Iq%jz)}h0`$rxXsL`|)wUk5 z45=+5&ioyaR-S;f3>xPxh*AtiBFTYX zIt)rGzDL{IBNr#e%fxl`V=(8wh2qk2z-a?TX#T7)C1Yo!WNt2qvYIauMgkQmcO>F4 z1O4zD#LFl5NSnL$qVDn&L~?R7+$TSWw6z8j#?7DcAF)EWM@qsGM&F8fY6cP|v!Ris zbX)to2(uLikfrQ_83ACx6xc0tI z=(W?K*!OzSB8Lh>Ibf0gh+^s`9COYh_3rPwJd5cvq3Po9iSwh!ApPo9$Qp{+uEX$W zdJha`Lz8?L@-YwR=$D9%sqHesLoPIzqB;Mwn$YX#K~=N|6yxI0^j>JG0T-!N$aBs| zGjpO##15&@jJc6Gwk(Ex=ZlbA>iE*12^5W1<%%aDs5GNBo>fmr`O7s|Yk zS;N0ntvBM7R^qfI2bHd^Ar(6$LNn|`&%Smhv}ND%B|mQ@GCNLFkFa8I3Ypj;5t`og zG}M(xdFz*fMC!&F>M=HE=Y~Y=poDHQ8p;1GeTA$m(W5m!n=k!^;MSqh`Us{pEW@Xk z-9d{Tl+YVCZbI&{AF%6GHQsmM0n<&>_%lCqm}pen7U0kFLgdGlVli2X@0(5rC3e80 zqAz#vA#2}#8?@8zu_=iJ<3CKxfwHsT8y( z8rsNMPn}zA~ycB3n0q!bS#RkBNzi#p9!+aC_qpsIA@yFSJYrQ~K?2PhO0; zQPTqQmd-F3OUXssHZ*89g3%STE%lb$%h2E)iw{W{4#|IF9a|t2v!@bU6R}&m9%FRF zMAcQ)htHfVB!6D=608>g;-Oll!Xsl6F~_kNDoZU}a;*`Z7h57TV4L_ygx@j;s;GpJ ziQJyrrb2Roc@3tpU7!>l>rH4446fVo7OXg}s^m+Bq1+NYRs1;KANGo<`ijarHt+Zv z7K{IJ*Jih4+{En4K)bGRXcH_&V=ka#y zSX@e-20}^DlsOyP1sf5Sd{dVRd_5zR7El@H4WMjEY&sK<3-x=yAyMIY#v#=vO=Z^5_et7ra7=ineeXZU%cfTzl8qo;9)Q>f6}DR;k-FJdlY8gJA*IjS%xGHre3u@ ziv(*dUm_kNCD@X-9c7LxziyXbLhn0pkUt8Hl(aNFG5;|nBqsKlCtuI>v^%MVjgLa< zR`4a_vFgqEqKWJ2zVRvap&xQdLzTBR6uyzm6}V^GGz`tm>@^~{@td&wG0HfMw*uqf z#nb$eFg}GoQ^=04JPTR^d3glDh zg7d7<0m3~1r`&!Ul9B?Oi0KZdYi~!EX)tez#~9a$uWAnQmUje&HZ(Ppvf@JC5>IMM zD#nc+$6LLV6n!$4n(5X+V=yZYIpq9Stt{r5wmP@tfoz*GLsH{X!u%a?o3b8y*A z8xKGHFw|-_KKke*zNB;J&Yg=TOO|w~)2X^MWR~V>RO&ACCE}P@Fb`XQ^?zR5$sy>` zhfkgb?G9|Y040%PNX9_k>YUu%T%13D9zXv0BPTLvUyXI#v}j>rp=WEOxVRX3d3jg2 z6DLkw-D+!VJzM*-&bHRpR{qznF+i7!G0j=LC7#2&Tr}951>>}!&@~koAPaEeOI%zm zmuc{pf4uqToBWY)>gwt`Y;U~r2DNhKN~%rJ&6_v#p9I#fU5g_}j(E03ix%;v*9h0@ zso^qVrx3yz(G0glcpagj(2S3%P$4uL4fNsRyd@0R?K!q>+lE7j4*8Yh#K*@|?Ki#{ zH{X0S#cd--jNnUvtgI}IA3vVrwwRdCN2S@WOvr43<x)$t?a2NgFZo zNr-DFfDlusPW6bv!Fr}=?~BI9M$&%ci#vr2L%xWmqoB2Gc}pA&LttpRF(kD|P-u%i z@L@Oifb&KBhgn;f-nDBN_V3^C)2pMSqpxn6B12SXs1+(`C^>J5gKI@&i|LBt1woHH zy7K@zcPtMsxA=9;BkrDn33p5s{C(Dw$-aI2uwlanELgCB%FfOv`T6-6GiD4v`|L9e zWCuH3*5PzIJ-@SN%^I?J@nX+++IRHWccvmo?|XHb78|{ zc%i}EL{{6s!bRDQ??HVLVOC?2WCjNH^FCe>ym;N@w}|}sMcxue#Z$vEYRyxEzkj{Z z>;sJCm%JL`%3<^k$0I zL!}W8m0pFGMQJH2!N07bGZIQHu+}wQjkPOQtRS;y%_8r-^NwKrWd{?UeOXzVXWw1e zX&Tmc&kRuzf;d)eAp{?Wjs2ATQ2w{Q16=sx)11HPo=!>|qZW>C|o zPvHcpfD^mOjVaqCPv+(3y$uxU4Nj`e06>z#q1l*V9wC8>|zAb8fW;UI}#@HuaZ=i)OXkpB1IU%f_2NeN*yi4NDSuC69M zJ-b(BY$3DU4DzF{-BdA*JynRK*~0Vfg11mVaS$wWpDC?Z)cJL=)Lt7*TrV<5ZGAg=X|Bn6-g*Cl38-1I+(E!&|+V-E53C`N$f)L0N1VTxZ}d z?+B`>Oo*VuM)l_{@hI8!Q1Wpe>;_}t-J***Qd>*D3THEh05cA`#fqsZiM-_b19?lX zM7<{P7qhZv6aK))Xn*kQRyt<{7e2V<#$g)^Q1;>8Ug6aZW;0ptaN>j?*@6%WE;mM| z_VX*a`z3T#&REzL!DV3@lN)ib{uk!bo)00r8VuMH8w)znkijCgJMpT^|JQteT}hS} zO_3*l9n4ZSFfs{h2i=5Iuc+|T*VR2H_QtJeN&V??3}Q#F0k2nKzn4~Cg{M>eUwP&C z2VKQ=gcDiWRAA49J?D7F;(GLCxhBvhrOs{<)j= zWLk!~bDXGq2KX*s$qv26RYS(c<+Zg2JTovg^g?r(7i}e)caMN#{PzTNf(9iM?nBl7 zkwEjcG>VS3B4KF*20s*msD2S$D)^yeHRSd66u$i-4sQBNCzeSGCf{L$`cDLVQ`K-u z{SPDD0Hr9wcS_eDQ6F~Kn~3e6_n8eho|G5Y8vWK4+0$CXVM5oK;o^?&1^x^9D>BG2t*`? ziLO_B$|@Sj*9UC)WVZ$d#d;={M0B^8$_kj+ek7Fk?x%Y0NgZVtY)a==ufJ zAj=;Df52*8NJNy8{cD+lJhoP{3E*xj{obX+`@{W%TSP$Qdl1imn`_rT!U zM=xRLIt}7uL=GFh5E7v|GH!{cCVndeHJ%k)^79p2qqg9GUueX-6=_sNm^>sRbA(K2 zj<{4EHT8>dxSuP7Ej&d3QAsyJQEm)KZNb{*1TQ}w7czm{2&vE<+Bg|C=j{wCb2R}y zu+@{6^==51N-G|oc@cZo%kjj6!Hr725ptp181ZB{HEx#-s)w6lif_C!^6O<#tP>0x zV8Ht;Td?`ffz)6>MxlYyWkPerXKJWvo1>{=TiASboC!qHJ7PB{aFpJOM`oI_dz}vR zAL#nEC0%}j_MBgDA?N>QgS|omoly@75r3Zp&!Y(|FoT##3+@^Z{PA}R{CcFi+uGl) zLbq`$zmk;y!wu7CI%u22p>X@Zm{PpZ#4{b5(Z32$Kcq#@3=I-v#ZL+aOOFWMo+H~Y zlEwoBOYc{sRx~sjk&&5z3zwSVaxq9rjDbwXiOoPErxC8x q^y>EX(MKPB^wCEjef04Q0r-C^$^zI-Cq{q(0000