From cf9311bb8394a68f4c6476c990579585f2a4a552 Mon Sep 17 00:00:00 2001 From: Adam Matthiesen Date: Sat, 24 Feb 2024 02:37:09 -0800 Subject: [PATCH] update --- .changeset/lucky-rockets-chew.md | 5 +++++ README.md | 31 +------------------------------ package/README.md | 30 ++++++++++++++++++++++++++++-- package/src/assets/example.png | Bin 0 -> 5810 bytes playground/src/pages/index.astro | 6 +++--- 5 files changed, 37 insertions(+), 35 deletions(-) create mode 100644 .changeset/lucky-rockets-chew.md create mode 100644 package/src/assets/example.png diff --git a/.changeset/lucky-rockets-chew.md b/.changeset/lucky-rockets-chew.md new file mode 100644 index 0000000..ebb2de0 --- /dev/null +++ b/.changeset/lucky-rockets-chew.md @@ -0,0 +1,5 @@ +--- +"@matthiesenxyz/astro-gists": patch +--- + +Update README and add example image diff --git a/README.md b/README.md index 4bbdb8e..3424914 100644 --- a/README.md +++ b/README.md @@ -1,30 +1 @@ -# `Astro-Gists` - -Allows the user to import GitHub Gists by ID through an Astro Component and Octokit - -To see how to get started, check out the [package README](./package/README.md) - -## Contributing - -This package is structured as a monorepo: - -- `playground` contains code for testing the package -- `package` contains the actual package - -Install dependencies using pnpm: - -```bash -pnpm i --frozen-lockfile -``` - -Start the playground: - -```bash -pnpm playground:dev -``` - -You can now edit files in `package`. Please note that making changes to those files may require restarting the playground dev server. - -## Licensing - -[MIT Licensed](./LICENSE). Made with ❤️ by [AdamMatthiesen](https://github.com/AdamMatthiesen) Under [MatthiesenXYZ](https://github.com/MatthiesenXYZ). +./package/README.md \ No newline at end of file diff --git a/package/README.md b/package/README.md index df63049..d58bb7b 100644 --- a/package/README.md +++ b/package/README.md @@ -2,11 +2,15 @@ This is an [Astro integration](https://docs.astro.build/en/guides/integrations-guide/) that allows the user to import GitHub Gists by ID through an Astro Component and Octokit +## Example + +![Example of AstroGists in use](./src/assets/example.png) + ## Usage ### Prerequisites -The Only Requirement to install this package is a **Github account with a Varified Email** to be able to create a Personal Access Token. +The Only Requirement to install this package is a **Github account with a Verified Email** to be able to create a Personal Access Token. This Integration uses [`Octokit`](http://octokit.github.io/) by `GitHub` to Generate custom gists using [`ExpressiveCode`](https://expressive-code.com/) within your Astro project! @@ -83,6 +87,27 @@ import { GetGist } from "@matthiesenxyz/astro-gists/components" /> ``` +## Contributing + +This package is structured as a monorepo: + +- `playground` contains code for testing the package +- `package` contains the actual package + +Install dependencies using pnpm: + +```bash +pnpm i --frozen-lockfile +``` + +Start the playground: + +```bash +pnpm playground:dev +``` + +You can now edit files in `package`. Please note that making changes to those files may require restarting the playground dev server. + ## Licensing [MIT Licensed](./LICENSE). Made with ❤️ by [AdamMatthiesen](https://github.com/AdamMatthiesen) Under [MatthiesenXYZ](https://github.com/MatthiesenXYZ). @@ -90,4 +115,5 @@ import { GetGist } from "@matthiesenxyz/astro-gists/components" ## Acknowledgements - [`Octokit`](http://octokit.github.io) by GitHub -- [`Expressive-Code`](https://expressive-code.com/) By Hippotasic \ No newline at end of file +- [`Expressive-Code`](https://expressive-code.com/) By Hippotasic +- [`astro-integration-kit`](https://github.com/florian-lefebvre/astro-integration-kit) by Florian \ No newline at end of file diff --git a/package/src/assets/example.png b/package/src/assets/example.png new file mode 100644 index 0000000000000000000000000000000000000000..7daf2da1f2541e9021974bb0d744a29ffae7cdb0 GIT binary patch literal 5810 zcmbtY2~^VCx+gWIoM==-MLVUI<0l{OJSQ_NEi)YISZXT+a%1aB43 zw?(_cVgUe!j?LeeE=0v80AR0++cAf8Hv-rb{aI?>iCs%SAeuTK6bd4w6{Q@2O>Ltp zdT+sn8sRh9-?OC^jc)|sz4EIO2x__vefHAf&W?BTxIM&)DO&jRj89-^94IUVrt#as z^%uowx#x=V%V|-86L>5MJDJwPJXd6i9C*bnVa8!MI_uv2^Vy990bxErpY4Itl8jn{ zNUY(_5FNihdmSrWif{~<$nC);uYVCP_Zo_|Fqb|+b?eNnDsMNEO+T|3zpH*b&;w3~3@u$uQY`$n(io=%M?PqJ>^rpNG2;8)7p}est@!GB=O*D6!?XdpZX1 z1|HPx(LFZ0&PI#$AAi^f0suVA&{o`qd4foQe#$YyTh~Yws)h`ku~Vi7Geit1~g zI*9ED1(#DjZN0TX2Kgo$0Kl`8NoZmFjKQ|VWv=ol0`}bV2(2GuhSJG1%UFKwSs%C; z_lO^Mohs==BXo6qlo_{D3B-p&*^ zmrU@`cUUkjVTBL0*emL@y-sg1efRNBDvcJGl$12j=*XNeFG<-Cs=2eNLeSRakCl%P z$Q|C6L0T0RMxxIegG3@bQo;AfMxdUUC!Q6l(ed$=4OOuk8C6@h005Os+_b~rI8ww~ z$as7pm`cxcl6XFcG03_N?Y==z5$LBb>J;8!m3-Y2T!bXULdAnOmezW(HC|tzFg@Sx z@+X^ri%as!kzjn7I=JQrIGH~ex?Ow7MZ+5UIY{izJ%R>7z|LT0(FZPWZDwmNy*BO+ zUD??#v;v_bOzHn3ntN{0zr=1@3*D)d;HYz8ErW1P_3294eft~fe@m$Q&CySF08f*( zb&hfjPy!B?7;+#s@QS{aEiV;{7^3{w{K1@3CHeHdLLC_MZI8Yb@s~^TKmfq!C2PJo zy-4HJ#0hl4fkelVxf1;g#nNrl`j-R^cZT@^%g*&@f;3v0QEJxLur)rH9lyO3%y-V9 zSe4fjc)zza2w%cXy-hWCiB8>b{#XD0i@S$+|BX#=VN$UP$jnrwPBWwcDGo@ayf(8EboFh=vo{Egs`J4U*5*%eNT$2g+|t z`?6}b7q|t`#x${`@FEu83q+|)zFnPQC}jSN@Z4fuUCNIth^{Y0NtOmWb-oP@1puNC zBnMUQT|p>n*@gNLPOGjpI|@hE+J*CxL1#15PuXali`JN_Y_lgc=rknJ|i```0wF!1jTU=jjmy2MsB}rZK->D;>Kd6^@J2(8qNR?~NlU0fL`0Rfg^#Xf1TmQUS7K&#m=jN|C7jVA|w z5x~K=^lR~arhi)=LH2_stEyo@JU}+MIw19WJbj}J7U&HIYOA8t5kL$QQf~|*Uyck~ zF)lplpnsv((Vz3{^_|9!*FK%JlUAVSQ+i!G#c@7*2jv(hP1I2>yDbrXrd+uKo~Ut> z zGWz%p|8%C-;<~3-23B{cG}2~UM*pg11=68P0X3WGk5;4YV<1!npGMQ)eak;i44IDz z%%&=}qN=d$7GFt+Sc6zk0Kop*w+*Y-yV$ggjx-PyCMf{`^k}rZyJ^Vv8f!3DuR~xS zJo(;BnxH5k++Ms~38rAK{j1$;}I7}5KVSd&}&nV4F^Fwg1=I3*}n@e z`{A$gGi_m^!W%Wc`x&RmrT4w7Pq^j*bT%F#x5bNCO!M^%d*zdJAdq7Wgri77^PI7= z7!Gyn*X(^z)nbSg$rBzsK`*W~N;xI`Qh|^|wvcayNSF_NjLyBEhNAjy^wC$x3fpWS2zbKP$iVV528a2!u)gQI(l`y4w`SVNdNA z=WO1;vvwu4_wv&7>cf<1r4&CsK{`UJ@ucLlbT=4rvOH_(CAI8rju{u)@2^?XSU{`-36I*4q=(%x6k3I*E~qd=mfwRP9S$6pJCY^qZ^V{f)mb zNYrhH=HKy2m_M=*e!=Xb_0 ze-rNg9|*dKL84wl@e!V&_bU1*@U!Ex|D-yA(_*j~q)H=OT) zw>Pq_qs#k*=LVI+A#YK}an@o9Szw??F%p76F${|BBJ&M{EK=Vn7$8SpcXTy-R10GW zEu02LD~6~Xf8jtYC*!&EF1dUaAggJH&0#OVyP(F(2K#`Rsr)f50N@_BQ7(O7hj@C1(=Ihu`Cu_ zv+WXm{kCVdzs7D+beLk^&f9j{#m9Ij3T=4D4 z68>>VfB#UFdTGspPfRYBeMA!Bq0z@LBPbH@i))$A9l)9G(4e)lzHzf)+zwefXjQuN zr4*F)q&d}dEI{q-@KW&bd~Aty>YGC)JAs*W*RfP1yT_Xv)PsPb6&;v^37Fv!J26l%_iO@`wG^=+*(eNTLu}@Mc?Sm6@$R*pUBhrTuSCx0~18|k)qZr)l)T<$gb*O*a z-S4SiDm&W(Wm7?bn~uILv-IAkyb?_@vYKD{Ph)QSA$Gdq@a{NP=H|I1Ce46}pSm07rw-x{9@xyfZ$G8-U9n#) z7EBVA=D)5FI*%rA`uyhj1sP&I$vb$F2;<#5-30tQWuqb`pDU)F;9uV9^poRdjpSXy zo*=R90WmBkpwRGvtHwz^#td+qID`SsjmeH{Wk0EZGbQfWT)Ew4^J5)Vv6%qRqW^P3 zKJ!HU)cme^)*Y|CYsp;`7B{}8jN`86L%xt#QM?eZjW8?Iy8-#3oC%-x#1>{$I8|}J z1zh4QkgAz$fh^3w)31#9&P+gu3Qm;v9a*w{{~mG%XZd^Ax?k31~{ zO=>mM1d)-nW~$Ac;X)6;e)?+Q1_xFyIDkkJ$|v_j8Nv7^$XMHr>iwXPjovfw{3a-a zGd`0ap(iE~OU;!@*9u5wm-}QPa!OSpgOZy2S&*OL=ciGXc8_aVvly7Q+M#dVbcA(9 zHix}!k7#;%X9lhg}kWuQXJq^oeR3bwWOh0q`J0hQ|q z7fdR2epIEt8}Pia!D-e+ioGzrgv7k&GRLOi$N9Fee0lQJ`}cgk^8-T6d1C+Z(JI~TIzyCcJXzfAz8_^poJiw1{|#j1 zlN8ariJ~UNQ+thIeciL4kA{jG1^E2+Pf{J%2g-R)R^DGMhMD|pHv+Pry z-H@`vA1H}H=p&-sN?b8S(}7vv>eAXi{OuayRLEHpdvzoz!g(gLK4+ANBfYr886}bm zxs9u-i$zCEnzLp+FqdPi4};=z-y;Z7^&S(pIpbmEwC4!Hv0?cb-7pM6Maxcug`p>o zFip{ES`KYYSu|~N`sB#>*>x886>1_o>+K1FCo@bvX4Y}IRt7a;>qiV36n$cMD#N%W zrhw@ap2j(WtSU4sg!@vxD#A$xJRAfZjvlOC8p#y+3ZIg_Ys*7Eo0+cK?BL`sV1njf zpiFcK=Xdn~`2xQ-#%kiDFmc~dV7hh+>Y{*&!r&Fdsfm13{rnK3Xs)N+wM*BC%uAuk ztR#>}ep?)Ge*$l=MZd7M2qoc;paSAqX9ZEG>@rs__pFlhSdhV^T9!P{k6G(gX})Q- znT;*8WO`kBppH@ZfXfIaPqxaBpsatKd|j&_hW3C&JvEWvL{`??(R6+IGLqV{?Jw=R zB~Rr<0EZTotD-m%*Mg#D^d%|}&#aoA{v&Bb8_Bhf;PcPHzRz}i04F{~!v7S*A@9S3&Am;YZgins?1Kf`o}ssK6$V(J@oLj7ataSQOlk?!yM-FGsG!PpU3E@M zgi&B_C0nMOo%yEf`5gSV-W5S~bc7r%NqfMgaslN(i_D-r^^dn+FdH5tXbwfMeHNS_ zwZ?#ejrYv;`b~^1gzhi7B-H&6kr;0mKESofiM?G}5ren&I^Ueo*VdsotRAQ~g+5?^ zFV|Es#g_3f?)*iu;hssHv+(Gcda>1<%(`V%;1`|)noIKDF(4a4yBwKa8+twB8~jl1 zm`*U6@G?qZJ4yjR*(i9gKijyDaK^hc8Z+LCCjA_&-iw}^7l*uvf{QLu0)C$!lbGp| z8~XJN4-aX;V`#+@Q9cxwpzM{E{$LC|>2h>H&T4f{CWZV68Cx-my*R)B?%-wOvq7*;AaJkXCcK!;kkp@$j*)rc9TR*5V^y3EHB{1n@DGW6zX+V3_(93 z8b(d*mVEYlB}Nce&7|vkVT4QMWY;Elye)k0u8i+O+K9%C=_;H5N3 zCrjgV!?Er#-|ATIDtoPUC1lTCc%rZawUbuLZE8i7_oG?k~RNeUvY@djy z)rF6te*sQmzhPfA+GHl0m-AwdDyH%4>$0V0wvX*t^&W%Z@fEmT99ktZ@Fm-WqD@*+ z7wxM`imF;bwUpm;>e<)D;a|K$*IF^$eeY~k6{2gXD^p0Gh+V>WusxBeC7%n_E6f64 zm@mpsOCZl-PohGGA3Zr@`uXVoS@>rwgyeL>Q~vuD_W?801+$@j(!|9XnH(w!M9w|@ z!~66P!_wB|ADTNB&Ek@iIYt9Lp{IhxfRAnJLNHIoI2KTuB3bH)KRRH#5oL8gz-^4+ zN^j~?R(!_aQo+?mv3QWbD(mX9rk%ZVhRjUPT~e&QU~V?mWJWLn`%xD=EO3zPdhb^= zxxFc80*#fVyULp5B0UDZdlSsTD_Vs|v)`c)v)6CMZe_a)deI?Qb4n6PQa?<1YDxpy z$A?6G{#QZNjwOpRIOYql{{~Vk0DV5bKgX%T2Ap5~esH~7AV-4#I)ptd*I)Z$-kDO| zIvxQZBAlH;9Rw?V=4LN6EG8xu2cuA!e6L$ecNc!YkVultc2A^n3cOea*iuxWN}`r~ z0S_D|q=O7TFK?D$KELfT5H|HIdSU*)_?+(|6uqTsO(QhwEH?|OH)qyeI@8-ro&SA> z<#&3s_5xV^|L$SAcdOU`3p_R(h=I7o?*Xkh z7{#_Irk(F&$pcP3l}_ueD&qARm-@m>mfdj=mkzMprgP_%wnAY6gcNq5+VP8dY6oq4 zbe+}YeFbcFYvB8}a+O^`Mc? zsG)3neV9(3_ixM1^{SgH^=prwI#PVw0oG?Testing +

Dev: Playground

\ No newline at end of file