fix: add readme

2025-07-01 20:46:08 +00:00 · 2022-07-29 17:33:26 -05:00 · 2022-07-29 17:33:26 -05:00 · 33ce86d761
commit 33ce86d761
parent c30d10618e
3 changed files with 128 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,53 @@
+# biscuit
+
+## A brand new bleeding edge non bloated Discord library
+
+<img align="right" src="https://raw.githubusercontent.com/oasisjs/biscuit/main/assets/icon.svg" alt="biscuit"/>
+
+### Install (for [node18](https://nodejs.org/en/download/))
+
+```sh-session
+npm install @biscuitland/core
+yarn add @biscuitland/core
+```
+
+for further reading join our [Discord](https://discord.gg/zmuvzzEFz2)
+
+### Most importantly, biscuit is:
+
+- A wrapper to interface the Discord api
+- A bleeding edge API to contact Discord
+
+Biscuit is primarily inspired by Discord.js and Discordeno but it does not include a cache layer by default, we believe
+that you should not make software that does things it is not supposed to do.
+
+### Why biscuit?:
+
+- [Minimal](https://en.wikipedia.org/wiki/Unix_philosophy), non feature-rich!
+- Scalable
+
+### Example bot (TS/JS)
+
+```js
+import { Session, GatewayIntents } from '@biscuitland/core';
+
+const intents = GatewayIntents.MessageContent | GatewayIntents.Guilds | GatewayIntents.GuildMessages;
+const session = new Session({ token: 'your token', intents });
+
+session.events.on('ready', ({ user }) => {
+    console.log('Logged in as:', user.username);
+});
+
+session.events.on('messageCreate', (message) => {
+    if (message.content.startsWith('!ping')) {
+        message.reply({ content: 'pong!' });
+    }
+});
+
+session.start();
+```
+
+### Known issues:
+- node18 is required to run the library, however --experimental-fetch flag should work on node16+
+- redis cache (wip)
+- no optimal way to deliver a webspec bun version to the registry (#50)
--- a/assets/icon.png
+++ b/assets/icon.png
--- a/assets/icon.svg
+++ b/assets/icon.svg
@ -0,0 +1,75 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+
+<svg
+   width="52.382698mm"
+   height="39.664326mm"
+   viewBox="0 0 52.382698 39.664326"
+   version="1.1"
+   id="svg72859"
+   inkscape:version="1.1.1 (3bf5ae0d25, 2021-09-20)"
+   sodipodi:docname="fabicon opt web.svg"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:svg="http://www.w3.org/2000/svg">
+  <sodipodi:namedview
+     id="namedview72861"
+     pagecolor="#ffffff"
+     bordercolor="#999999"
+     borderopacity="1"
+     inkscape:pageshadow="0"
+     inkscape:pageopacity="0"
+     inkscape:pagecheckerboard="0"
+     inkscape:document-units="mm"
+     showgrid="false"
+     fit-margin-top="0"
+     fit-margin-left="0"
+     fit-margin-right="0"
+     fit-margin-bottom="0"
+     inkscape:zoom="1.300746"
+     inkscape:cx="124.92831"
+     inkscape:cy="106.47736"
+     inkscape:window-width="1366"
+     inkscape:window-height="705"
+     inkscape:window-x="-8"
+     inkscape:window-y="-8"
+     inkscape:window-maximized="1"
+     inkscape:current-layer="layer1" />
+  <defs
+     id="defs72856" />
+  <g
+     inkscape:label="Capa 1"
+     inkscape:groupmode="layer"
+     id="layer1"
+     transform="translate(-60.052883,-81.833223)">
+    <g
+       id="g73848">
+      <path
+         style="fill:#898f8c;fill-opacity:1;stroke:none;stroke-width:0.105"
+         d="m 77.78561,100.07756 c -0.74854,4.03168 1.36028,8.44105 3.63048,11.65499 0.76576,1.08413 1.84117,2.84277 3.29951,3.00626 1.21202,0.13597 2.90472,-1.40217 3.78,-2.10966 0.36992,-0.29894 0.94248,-1.05997 1.4699,-0.74277 1.43304,0.86194 2.32774,2.80129 3.5701,3.92332 1.66257,1.5017 3.68371,2.52273 5.66999,3.50888 1.98073,0.98333 4.16976,2.00235 6.405,2.17897 0.70487,-3.40589 3.62743,-6.96381 6.82499,-8.295 -0.4306,-0.9156 -1.47378,-1.2769 -2.41499,-1.4239 -2.01464,-0.31469 -4.11285,0.29998 -6.09,-0.33443 -2.51485,-0.80692 -4.43918,-3.00121 -6.40541,-4.66189 -0.7287,-0.61551 -1.51735,-1.42274 -2.41458,-1.76977 0.65614,-2.27871 1.40143,-4.42774 1.56555,-6.825003 0.26701,-3.89896 -1.44606,-7.99889 -4.50555,-10.44602 -1.9152,-1.53188 -3.91534,-2.34289 -6.08999,-3.37596 -1.8647,-0.88584 -3.39591,-2.5916 -5.67,-2.53077 -1.90155,0.0509 -2.78806,1.64193 -4.30499,2.42091 -1.05063,0.53948 -2.27945,0.76416 -3.36001,1.25927 -3.0367,1.39139 -6.05884,3.24012 -8.39844,5.63758 -3.22838,3.30823 -4.88029,7.579 -4.10489,12.179993 0.30441,1.80631 1.18473,4.37293 3.36834,4.49295 1.66435,0.0916 3.38325,-1.33078 4.725,-2.13581 1.03421,-0.62055 2.28039,-0.99603 3.255,-1.68902 1.11478,-0.79265 1.97988,-1.94239 3.14999,-2.66374 0.92884,-0.57257 2.08898,-0.68975 3.045,-1.25938"
+         id="path369864-82-2-3-8" />
+      <path
+         style="fill:#dfe5e9;fill-opacity:1;stroke:none;stroke-width:0.105"
+         d="m 111.17555,112.88755 v 0.21 c -2.51905,1.54203 -5.4896,4.28201 -6.29999,7.245 -1.45141,-0.0624 -2.77315,-0.60574 -4.09499,-1.15374 -2.42645,-1.00612 -4.93101,-2.22852 -6.82457,-4.09784 -1.68956,-1.66781 -2.82136,-3.81895 -4.83043,-5.16977 -1.14964,-0.77301 -2.40533,-0.90867 -3.675,-1.33864 0.45918,-1.38432 2.01643,-2.19367 3.25501,-2.76245 0.84157,-0.3864 1.92244,-1.31344 2.835,-1.40458 1.56039,-0.15582 3.40031,1.09914 4.51499,2.03815 2.09286,1.76305 4.28158,4.30574 6.82499,5.39721 1.95751,0.8401 3.96973,0.16978 5.985,0.31111 0.85323,0.0597 1.54214,0.39637 2.30999,0.72555"
+         id="path369892-7-5-7-7" />
+      <path
+         style="fill:#dfe5e9;fill-opacity:1;stroke:none;stroke-width:0.105"
+         d="m 94.22389,103.73414 -1.48416,-0.23959 c 0.30365,-1.30028 1.14312,-2.45552 1.50182,-3.756513 0.90558,-3.28374 0.20088,-7.06295 -2.20123,-9.56013 -0.84365,-0.87716 -1.81642,-1.68063 -2.8345,-2.34807 -1.22443,-0.80262 -2.06794,-0.98378 -2.85121,-2.30286 1.36529,0.13372 2.74412,0.99706 3.87308,1.72549 0.98991,0.6387 1.97247,1.3684 2.76379,2.24602 3.8927,4.31727 2.99331,9.23033 1.23241,14.235653"
+         id="path369888-0-6-7-5" />
+      <path
+         style="fill:#dfe5e9;fill-opacity:1;stroke:none;stroke-width:0.105"
+         d="m 80.75018,82.790847 c -2.11775,0.18734 -3.9062,1.55745 -5.15095,3.20737 -0.40659,0.5113 -0.78493,1.04448 -1.13922,1.59322 0.65257,-1.00756 1.26966,-2.0373 1.89173,-3.06394 -4.01184,1.66344 -8.1914,3.44725 -11.13277,6.76942 -1.39959,1.63616 -2.60521,3.56159 -2.99814,5.70588 -0.34405,2.13885 1.00799,3.987553 1.90515,5.799463 0.46885,0.89423 1.25596,2.17452 0.68408,3.93482 2.20474,-0.89478 4.3388,-2.77361 6.59683,-3.52479 1.04818,-0.8651 2.01495,-1.864 3.11758,-2.64166 1.10122,-0.45261 2.20409,-0.901233 3.30424,-1.356433 0.20037,-1.27862 0.37559,-2.56351 0.90032,-3.75875 0.4672,-1.33123 0.93463,-2.66237 1.40079,-3.99396 -0.58425,0.4536 -1.20063,0.86705 -1.7637,1.34712 0.91888,-1.69492 1.50387,-3.54856 1.85387,-5.43898 0.1353,-0.33711 0.23307,-0.98421 0.68889,-0.9576 0.77324,0.67141 0.80137,1.83022 0.90376,2.78295 0.0789,1.16285 -0.15754,2.35952 -0.90376,3.28181 -1.69376,2.671 -2.90145,5.78765 -2.66715,8.998863 0.15268,3.11908 1.42078,6.09773 3.30568,8.56103 0.38376,0.53726 0.7038,1.35766 1.05848,1.91457 0.62542,0.14036 0.93737,-0.1044 0.92316,-0.75105 0.29772,-1.84544 1.2544,-3.97094 2.96731,-4.87644 1.67168,-0.93946 3.86842,-1.21585 4.96711,-2.96308 2.79949,-3.740853 2.80945,-9.439513 -0.34583,-12.977013 -1.02738,-1.12859 -2.18025,-2.23377 -3.68496,-2.66939 -0.46715,0.0679 -0.41173,-0.35487 -0.76668,-0.86609 -1.08342,-1.91083 -2.74785,-3.87495 -5.09009,-4.05881 -0.27552,-0.0284 -0.54994,-0.0142 -0.82573,0.002 z"
+         id="path369886-3-4-4-8"
+         sodipodi:nodetypes="cccccccccccccccccccccccccccccc" />
+      <path
+         id="path369890-4-0-3-4"
+         style="fill:#c4c6c8;fill-opacity:1;stroke:none;stroke-width:0.105"
+         d="m 61.06212,100.63424 c -0.57591,1.50298 -0.22809,3.21694 0.37144,4.65774 0.39627,0.76014 1.22937,1.75582 2.18374,1.35269 0.86909,-0.5462 0.39563,-1.72342 0.0955,-2.47142 -0.62453,-1.55489 -1.44739,-3.01794 -2.26254,-4.478823 -0.12939,0.313263 -0.25877,0.626543 -0.38816,0.939813 z" />
+      <path
+         id="path369896-9-4-8-7"
+         style="fill:#c4c6c8;fill-opacity:1;stroke:none;stroke-width:0.105"
+         d="m 84.26313,110.37997 c -0.23248,1.19921 -0.23853,2.47677 0.27591,3.60857 1.58701,-0.38357 3.44289,-0.94231 4.12827,-2.59514 0.24236,-0.49078 -0.86862,-0.50777 -1.20861,-0.79342 -0.98076,-0.44184 -2.04839,-0.66629 -3.12524,-0.64741 -0.0235,0.14247 -0.0469,0.28494 -0.0704,0.4274 z" />
+    </g>
+  </g>
+</svg>