From 66a4a63c86fff9109c54bf25f6ab230eae9d5649 Mon Sep 17 00:00:00 2001 From: Steve Date: Thu, 28 Mar 2024 10:38:23 +0100 Subject: [PATCH 1/2] feat: branding details --- .github/workflows/release.yml | 37 +++++++--------------------- .npmignore | 14 ++++++++--- README.md | 4 +-- demo/img/android-chrome-192x192.png | Bin 0 -> 1600 bytes demo/img/android-chrome-256x256.png | Bin 0 -> 2318 bytes demo/img/apple-touch-icon.png | Bin 0 -> 1544 bytes demo/img/browserconfig.xml | 9 +++++++ demo/img/favicon-16x16.png | Bin 0 -> 492 bytes demo/img/favicon-32x32.png | Bin 0 -> 571 bytes demo/img/favicon.ico | Bin 0 -> 7406 bytes demo/img/mstile-150x150.png | Bin 0 -> 1359 bytes demo/img/site.webmanifest | 19 ++++++++++++++ demo/index.html | 17 +++++++++---- src/index.html | 7 +++--- src/sass/kompletr.demo.scss | 15 ++++++++++- 15 files changed, 78 insertions(+), 44 deletions(-) create mode 100755 demo/img/android-chrome-192x192.png create mode 100755 demo/img/android-chrome-256x256.png create mode 100755 demo/img/apple-touch-icon.png create mode 100755 demo/img/browserconfig.xml create mode 100755 demo/img/favicon-16x16.png create mode 100755 demo/img/favicon-32x32.png create mode 100755 demo/img/favicon.ico create mode 100755 demo/img/mstile-150x150.png create mode 100755 demo/img/site.webmanifest diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 377ba22..0d97a68 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -35,7 +35,7 @@ jobs: build retention-days: 3 unit-tests: - name: Unit Tests + name: UT's runs-on: ubuntu-latest needs: [ build ] env: @@ -60,7 +60,7 @@ jobs: github-token: ${{ secrets.GITHUB_TOKEN }} path-to-lcov: ./build/code-coverage/lcov.info e2e-tests: - name: E2E Tests + name: E2E runs-on: ubuntu-latest needs: [ build ] env: @@ -96,7 +96,7 @@ jobs: build retention-days: 3 release-github: - name: Release on Github + name: Github release runs-on: ubuntu-latest needs: [ unit-tests, e2e-tests ] steps: @@ -118,7 +118,7 @@ jobs: with: token: ${{ secrets.GITHUB_TOKEN }} release-npm: - name: Release on NPM registry + name: NPM release runs-on: ubuntu-latest needs: [ unit-tests, e2e-tests ] steps: @@ -143,12 +143,12 @@ jobs: with: name: build-files path: dist - - name: Release on NPM + - name: Create NPM release run: npm ci & npm publish env: NODE_AUTH_TOKEN: ${{ secrets.KONFER_NPM_TOKEN }} - deploy-demo: - name: Deploy demo website + deploy: + name: Deploy runs-on: ubuntu-latest needs: [ release-github, release-npm ] steps: @@ -168,7 +168,7 @@ jobs: registry-url: 'https://registry.npmjs.org' - name: Build demo run: npm run demo - - name: Copy files using SCP + - name: Deploy demo using SCP uses: garygrossgarten/github-action-scp@release with: local: demo @@ -176,28 +176,9 @@ jobs: host: ${{ secrets.KONFER_SSH_HOST }} username: ${{ secrets.KONFER_SSH_USER }} password: ${{ secrets.KONFER_SSH_PWD }} - deploy-docs: - name: Deploy documentation website - runs-on: ubuntu-latest - needs: [ deploy-demo ] - steps: - - name: Cache dependencies - uses: actions/cache@v2 - with: - path: '**/node_modules' - key: node-modules-${{ hashfiles('**/package-lock.json') }} - - name: Github checkout - uses: actions/checkout@v4 - with: - fetch-depth: 0 - - name: Setup node.js environment - uses: actions/setup-node@v4 - with: - node-version: '18.19.0' - registry-url: 'https://registry.npmjs.org' - name: Build documentation run: docs:build - - name: Copy files using SCP + - name: Deploy documentation using SCP uses: garygrossgarten/github-action-scp@release with: local: docs diff --git a/.npmignore b/.npmignore index 4633e00..5636ee9 100644 --- a/.npmignore +++ b/.npmignore @@ -8,11 +8,17 @@ # Node modules, can be retrieved by npm node_modules -# Retrieved by bower -src - # E2E tests cypress # Github workflows -.github \ No newline at end of file +.github + +# Build files +build + +# Demo files +demo + +# Docs files +docs \ No newline at end of file diff --git a/README.md b/README.md index 619af05..d354562 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Kømpletr - Vanilla JS autocompletion library +# Kømpletr - JS autocompletion ![Github action workflow status](https://github.com/steve-lebleu/kompletr/actions/workflows/build.yml/badge.svg?branch=master) [![Coverage Status](https://coveralls.io/repos/github/steve-lebleu/kompletr/badge.svg?branch=master)](https://coveralls.io/github/steve-lebleu/kompletr?branch=master) @@ -6,7 +6,7 @@ ![GitHub Release](https://img.shields.io/github/v/release/steve-lebleu/kompletr?logo=Github) [![GPL Licence](https://badges.frapsoft.com/os/gpl/gpl.svg?v=103)](https://github.com/steve-lebleu/kompletr/blob/master/LICENSE) -*10kb of lightweight vanilla to add simple & efficient autocomplete.* +*10kb of vanilla lightweight for a simple & efficient autocomplete* ## Installation diff --git a/demo/img/android-chrome-192x192.png b/demo/img/android-chrome-192x192.png new file mode 100755 index 0000000000000000000000000000000000000000..0744cc72a91afbb0d4ee644d1b96b61f51fd3afa GIT binary patch literal 1600 zcmb_ceLNF*9R6)n8*-99D63o4@)9i+hKyU;%&-|MqLCrVV&2QrQ7K>bJ#c(9qm6?Vv#B9m}B0sv+8Z-9Wjd@Z>NXA#LK;1U>8Q3F1c$ooM) zI7r0X(PGBt$LCy-?pj+vN(*w^YK;#ymA&;C&!gU_!qAnE^@6Y8C9idVWgkNatv@H+ z-*2Dvz}rm%?LI@N)1zCYxx=cBIvxWxEtr8zSBk>;{No)D^KBv+Fs@rf4^DGC;Bmm< z76pzm3a}uMVr2w4ivtoU^#6>e*s3+o^%+zpYI^Pfl%H5gnm@igR-A7iZs=|a!~G_G zqzx+srqoh*i$Gca={n zj26mY#daw*NL9v*h#}@C@eQ^!qm|VT(3}l?*L1t+gAb+R>1OiaS8+4Zpa3h3y{Z;L zivP8LTdS|Nci;1EHO6cW^Lx#omwvoPwK^l=DWOLxqx2hlIN9c3%Rc zZNcS1{i0G0V;>3-LKxip)@x2$$Y5*eFk`K zRr5l3QVlGO7uVO`n+0jaA)^Ww<|g42vx{lhR%7x!o-n)v(<0Spq3fod(@SZOwSikg z$R&YHni2<=!m2tVt|;_Q+!1H@E4bDUWkz%izD4YI727OL*Z-MX9iczIU50hv195f= zfam;CU`JhjL&|ay-py0Oy@yv&1iK$v5k#V<5Q8Ec3n@i%5n_-@ugh1|iF{DUSHg5x zsN$SH^NwndgO!leqkhM7otqd*aI=#=SU^Svtu+jtgf|yLRlZ}|CTk<7+JAl_;V^8I z$A=}rGI{rLD6YKky_tTgqX@0j^1-Z&c5h6Uc(ZI{eUC13pF3xAho|DyXwQ+`hgoX7 zY}7r4>wR0}D5Z|Li{W*GX`ErkkSPU2s+jE0x~*7zt-W=PQ8qG3#*5)D(Vc?wXTR8c ze0<}0RF))}Yvx6k6zuYyn=I^nsjZsX-*9Zr@4~~CnCyz>w1ea*HBIxvLW_W%aholW z32bLu!mDZ8xR2}R_0(Kz*~K2V8S|yRvTM4|hbtvUGZk=G%U<=|4Ak!(FKm(bVf^mE z6nsg>aT>e(swebKkSD*vp}2Xqm5?~(a@ge6PmRis~a?*P}Y6+a9xssZ7#0 zm67^Ec!I2!EgaDF>;9ZD_DHul2k9H_ax>LrcsO+oLOb0W$UWJMNak5@@-yk%DHmoY zcwefXgc@Y5u1<*#&L^PNKc*^L6|Dt3PEKAmzUAcVb99B`n3_i3yQq==QW_&@h%*6B8`P+z^AoVla-2`-uN2god3D zX2kw`!KyBIMPBfXqn%<=>Cq@=co-x2VgQO2%M3sTGgSJ|KY@o)ILr~&{0 literal 0 HcmV?d00001 diff --git a/demo/img/android-chrome-256x256.png b/demo/img/android-chrome-256x256.png new file mode 100755 index 0000000000000000000000000000000000000000..f1fa6a1bb97c925e0184139352b66c16744d226e GIT binary patch literal 2318 zcmds2dpHw(8~*K}k?0kr9A1+*Eq&O#NR4Egm_urlYyvy@?%!f3=Y@s7Rw{`~&<{{F7(yRPTC@8`Ln>%N{p@ATux>{T{uZ3Fv0S-hL01^!WU|j@YRW7ln0XT;S zV8#~!Y&HOz(YcK$tmFr%zmq*4$kH-8dGbvu+QB0h0A=-mHw4_x-7XgqRDz2gVj8BS zv<)$t+;~K;VQv4^;$Y(e0p{*Of&v&|PaZuF%rQY_XX76j`&?EwpThx9;CTt0; zu&(tAB`3AMUd9&tqBrC#bNoz#mmxR(wTFVSujm`*=i8k!zeF)&gUn)sUe9c_o^u~j zXfOc(MnVevN-%LkX;q20%;Kgrr9?}Y>NCRpsH(2v zxWU)$O|jvda)sY)8J1k8=kve0H}T0-w2g=zrkA^gWqEF;ZzWy-Lsu7;d8jBQR@0R4 zlQ=os2T-|9lD}5`5b*&IDX2Qj0~qr|v{}L4zEgp&IgEOvJXv48W?J|hU2ttJ?9%PUi-jD%wPvD7m67mX-kpqUDyRx>y?23W$x7Sss`69LKPpt7k{+I_$+*ywE+mZi=CR3^QSJZ>04- zT!)~LJKNR;I%RCz`-Oa;!$4K7zsK9hgWN?vyc)v*$hb+g7NPoCo*fI{R9>TaeOk3rj;LTYWRENDFsPQlCAXKqOsvb zuV3|Ar0*YA8+I({09u4EJ2%8n$4Mz~Sa8gUwK~wT6hJ>QWDMJGTv-u0861^8ahO*CIyDn1Xs@vQv*$f&P#elXN-+soIBu2~EfUehc~5RV2)=1b=`+f31xCF4(& z3;tx4u1U)TV#geZM-}EHBhSREUODiJ6dnF=SrQu*J8^gOyCfo>z)0ByA-x((fE2)? zshgd3o|~GM(3Qfp);Fy;7mJa{A8D+ra9*Wc29)80*|=)$eH5`vUvzS!auuO;b!z}6W3!6HvKA{ zqme&5qeB4&EaL(dGCb5(b-z5v)2hEaJ+SLhxYyE18(qc zy0o>i#|Q)G#EVBSC3@io4*QHmh{8qsPOiUf!R@KwfBNy0GX-j8qW5vyV_7DNiHAEFl3g=tK z%)&!dZQkD#O)d>zz&4v^)BVOgPR@4m=R0LtDe#ikeh=#qldg=+$DN}ZF8KA1fvJwT zx~ujf1uLxav*pA0_4aJb{U(x!BX!zB&y+vr@cm0rwbG4-CVw8PNwqJ)4}R$Z`xV=z zO?S;B8KoL$LG~mVQU>k>ZoQ29T+-%PhPN!ec+!8Ezp}<_?_J0Rimd;ANx4!4S!=(t z`~4f;^6=h8wR5Ki`cWy^fEbFL00xaQGe++-#vCA_4`MMGEZSl(8jVGx9q084|6z!T z3JeWO`0obG>YOFH!7Y*GP9^%qA){lWfQ1*bVCqOb%d9mJW>7;yc6{uA+t%5p(}w6^IdB|Jz>KCEbpS6aWAK literal 0 HcmV?d00001 diff --git a/demo/img/apple-touch-icon.png b/demo/img/apple-touch-icon.png new file mode 100755 index 0000000000000000000000000000000000000000..93839e7da78b6b19aef4d501648dec4a564c5c99 GIT binary patch literal 1544 zcmbVMdo&by6#kVrJ1Or)HFioKVaRiiC^McJBRj{dVl>7pGGj&>de#Wgi={T9HAkO_kxcAGY=beq0TNeh3 z3Yt1u#I-JI2$cOo$GlXo_Jk}t%)xN4gL2`JJbj3+%ijH8WmNM!I@$PpIxXJQoH}j# zv+k=Xi3I3w*&w7&b2Ff2UxXMq0X5$y(y4{L0)SeTJwNEVO6fG)BL} zgNh0^N_<`1@%2tHI3qde*O@sq(0?Jdb^L6#T%fwDI}!o-5_;8Hjr!WCYv&H6x7}Xl z?W`?3G>GZ?^T&aqkhE0V;8OB(=0UDreSt9>ca<<6X}( z)4hk={IbVY5f0sBXP7V3dGroj4YJ8dtwY3}=1|ijGK+nhD@s(f+O{9rSgUc!Y9L0+ zYR=EsZau{~t`B>Prlafr__DDI#YQJbnQJ*6Ok^OD$eOd#aSx@23<&%f1*MN+CqShR zFtfBaU3)Be!qlPd97-Y1`i%Tye0A-Hw`D|G)C0T2!!vJgvle+mSgzCvZkhizX$0Xjy41&|MgTSi-4fPn(qPd1*dkYBevZb%~Q0|mO z%SLDqw{+l(#a#j;Aa8GD-~*{ZTXQQxB;=mL-0$vMirxspOA;$Vg{lY_8dKKlCRzUP zmpp07cFTgxt@mv*ActbL(P=Qj@O-tt~#1u1k}R`kq+X>$EXC zXTyd4kT8toD0?%k$&8<16%}j^+)7|Fl6$D{CrR~|Vh!$HG6dM!%lNPv!ivbPG?ejG1-F&QEaV0m^rI`MMA)l8*8r~eB@_Uc;f=& zGt;Lg+gY7$w11(-c00-C)qK5gxzqpt?!RZjPrEKoxOH<8NVeII4T!6H|@0=PPQpdL8juKopbT&qL? literal 0 HcmV?d00001 diff --git a/demo/img/browserconfig.xml b/demo/img/browserconfig.xml new file mode 100755 index 0000000..b3930d0 --- /dev/null +++ b/demo/img/browserconfig.xml @@ -0,0 +1,9 @@ + + + + + + #da532c + + + diff --git a/demo/img/favicon-16x16.png b/demo/img/favicon-16x16.png new file mode 100755 index 0000000000000000000000000000000000000000..7aeafe19cd872b34684dfa0bddff210df8c3b6b1 GIT binary patch literal 492 zcmeAS@N?(olHy`uVBq!ia0vp^0wBx*Bp9q_EZ7UASkfJR9T^xl_H+M9WCijSl0AZa z85pY67#JE_7#My5g&JNkFq9fFFuY0t>0)3IFPO6{&;}^Ml;rL1!tlSn|IB_MkF&rd zvY3H^TNs2H8D`Cq01C2~c>21szhIW(6k~tZxXT$RRO9L57$R|bYTrh#LjeLT>F;Gv z>Ua2ZM0B=J`2U}aTd~({o1$Zo#>w3ximef;yJaQHu6~eCHZS0~d@b#vOYJ-##)N+B zKELy?t}zG1-M%S!H?@NK!%wbu57$#nO3Z%qUWJ!NOf{O^S8`P1G@Xzme6lMrqk8o>d@ssFt`!l%yn2I`Q&6e6=(&6r>mdKI;Vst06|fmApigX literal 0 HcmV?d00001 diff --git a/demo/img/favicon-32x32.png b/demo/img/favicon-32x32.png new file mode 100755 index 0000000000000000000000000000000000000000..199b9dbc6953c1af4f0ad55b06f619307072c765 GIT binary patch literal 571 zcmeAS@N?(olHy`uVBq!ia0vp^3Lwk@BpAX3RW*PVOS+@4BLl<6e(pbstRTr`k04(L zhAK4%hK3dfhF?ITh8GMBr3MTPuM!v-tY$DUh!@P+6=(yLU`q0KcVYP7-hXC4kjGiz z5n0T@z%2~Ij105pNB{-dOFVsD*hZ+$%-6h01hdL{gf?3r^iNxBvftp}<+? z59|yMObih-%U<#pRA0EX-Y0>9;pxYzTnBoqw$EzF)%E+rH0Ao-rF^NCQ)m2g_tv(E zyfy#E>e8cy^E&!Hg+A`v{M*ZAsmKB4jqk#O`JKET?`Mnn`8Y8_%lW&)3j_B>JCZJW zayOiliIs4f8fqRP#K6V4!F*Eb$G2_V2Wq&rz9;wv^!;S7J0on=Z@j?ziXjuwTdF0l z5hW>!C8<`)MX5lF!N|bKMAyJr*T^Eoz|zXd$jZQ6+rYrez`*Ohq9=-m-29Zxv`X9> ztT)a43e*r@6%tVrlvu7%P?VpRnUkteQdy9ykXcZY%)n4F=kX^Vj>0evjZ^-o&v-r! zVqjM0)=TCVRu=Z2EW#|T;L>1nIE7hxbBMy}8&^&oIdeqj2>a;`=zy+Qy0 literal 0 HcmV?d00001 diff --git a/demo/img/favicon.ico b/demo/img/favicon.ico new file mode 100755 index 0000000000000000000000000000000000000000..2835526477bfecc638890f5a78a535b7151c340d GIT binary patch literal 7406 zcmeHMSxa0=6#hEyYrC(lcDFHYw$^rQ_a*Lg$5zKU(HMFds3-_(^5Bx7 zNRS9BCN2*lA$g3LJSl>pLgG^%@)xG6?B%w$!XV59=6-OyPTe|nPTjBZdcM_4Yha(;b8=-2hipMPx#&Iyo8y6fijM6MA3mU{s0i8F z*_fG`L2PU+Mn^}{)6;{!y**S`Rw6Sq6E9!BM09jCy1KgX`SWK?PfsH%Dhf3S$|Nb4@+uL~h^eNWY*O8Z(hxz$=q@<)EEG!JGtE({TCot?$l*cg8N_<^mhEj)bq5bxi= z$DKQOkd>8%n3x#U*Vp6SyLZUQ$iRyiFQ8Vd(b?IF-Q8W(*4E;|g9lhxSU_4@8m6YE z5E&VXqoX72?ChYrx*Fx><;c&^M|gNRhK7dl?b|o3t*s$9Hy6pt$xx|OxOeX!5)%^< z5)y*`{(c-B9N^KTNBH>hBUV;c5Fa0p@$qqd`SOKFwqObj{F)4;3lJC(7)Y0-yPXG# zc+U^s#bP8znG9kc5*;rJTehIC)AWKY=*VIbGr+ z5{Yb#qUa}_=;|fDe^NnwI%gkzBeT#=@548Uzv`sF#5XoMBZ2Q_uub`=OSAJlH3lEP zWzwHZlQ~KGUIyE=zjxlPe-i(8zPn|PAtvAALQg+07abgsdHoE2PWco5Ro2!@e|}Vh zP2wBz?{+!DT&hth6dLj!n?ksU4WEB5&MNE5If#n6W@pGot^ANbZ=MYYi{JR+iN7Q) z=p5X3JK;`uoCkUY0RjWRJOjUGRrdcm71gOyawU^XuT#y*LrVpvc zTU=aZ`f_-9801~YG$Yldj~_oqTU#5`a?8uh==x zv9S>y9UV-+QH@76Z*y}q(~fW7zC~eSA=89Z+fm)x-QCSJ9@T-bUcJK7(h_=md$F;x zf#Tv~rZb;Ef6nyhlP6Em-rkOqk`ktMsZOPOd0=1wrKP1zuTo7M7Z-<#i3#N7n` zdwgLO7!Vks{Vo9)W|g!H~D(6Fv>^9hd8X44JE>&|{Rw9!njhvAA$w{kr4 z_gmP8T1NSv$RDTAAK>p{D>J)EWE3BlJ#`twVk}8(@B|dzv1)Bbwak^YEE(*SN;?MS zC3D@fRBDoc!?N+gg&CiL|N0$B>lD&rXSIsHPSMsT>}*>5{{8!`PNDS)?Hkj2Bq=G0 z)g!cjUQkfLddTE&g!Rm6oiR8#h_bRWR%6h9Iw_i2Kb+PYv`1Z6SBKWtR#sQgo;K}8 zH#9Wp>xz+)5ms9?H8p|bI96BCnu7MU1qciX4E%cxh%XGetq%Tj5=`zblab%|7@Wxs zxqG0G=W*-B)80)i76rKa+4<8g{^m|zWNt5Y@Rl=J(Ye@OW@%=@a4Eo??6>xH@v!uu U@U@|bm5cO^Pnz$7xG2+q1Lv;HSO5S3 literal 0 HcmV?d00001 diff --git a/demo/img/mstile-150x150.png b/demo/img/mstile-150x150.png new file mode 100755 index 0000000000000000000000000000000000000000..798426fd037e0b035b9653dd2fb9fa05125abdbb GIT binary patch literal 1359 zcmeAS@N?(olHy`uVBq!ia0y~yVB`Z~4xj)-?5$;$K#C>Z(btiIVPik{pF~z5Um@8e z$d`ekN{xY`p@o6r7f`6-1p`B=0RzLU1O^7H84L{K1#@-<+5jb(N`m}?85qhYpS1w- zlDyqr82-2SpV<%Ov6p!Iy0X7umf;j*f7ZCmnSp`%nWu|mNX4zUch2TZyUMhGyuaox zi*>DMrh+2N(yp!r8x2-!#jT5(pvuI)L$PtfsrhV7T7^!ox*-aUB1^VR&A9BgM?{g& zMCGja)GdB@D#|Tbg7z(Xb<}vbna%uQKjHI_@80}am1+#M8y&o0)w|-boNMl}rw)%* zTF)(dKEau~aLQx8_j2~7Yo0XoZm<6QDM;*%9;Y$gN%1$O;Pj~JN(tMS=srt@8!NB4#Un)O31QxUW`LIp@-L1nXl};!|Si9U`D_i)q zy5!5Bhm)?~dbqhPYv1J5y|qW4Y|&opJEe~=$|&r;POg~k(?i8SvWm+V80Gbw#Cz?x z-hA!wavwYQ;{}@&)28+G-FoQ#+V%X-4>D`B7uWw?oRhfpg{Hla-FNG4c6$PDMmul* z|Nd{^@9dWNyZe=IyiM;jd9_sYo%xSvwKF(=Pl~#-*73+eYw4BNCK6>n_E%OMJtO$> z#f_gI-(5KQ@~6p*($Y6i4&=q#U3gF?zP{gQp4^|*-*FQZ?wtvpU-Nm#-5;9wj;TJn z_%MH7ZB)Hnx|`z9Skx*?_62@?ChCJD=Vm;IB_b0j69^w56 zRG?bo8c~vxSdwa$T$Bo=7>o>zOmq#5b&V`S3@ojTjI0dIwG9lc3=F*9D|(`6$jwj5 zOsmAL!FtoouRsmqRUr{2L5bxG1x5L3nK`KnC6xuK3Yi5Z$qWn?a~^-<;V2B#&^YCP z`i$q(AO>b-ZoOn~VP#?O$s)|c3N8&Mhf|o9H-{*kzH#NmkuyhRj + + + + + + +
-

Documentation

- - +

Documentation

+ +
-

Kømpletr

- 10kb of vanilla lightweight to add highly featured and eco friendly autocomplete on your pages. + Logo Kømpletr + 10kb of vanilla lightweight for a simple & efficient autocomplete