limepotato/jormungandr-bite
1
0
Fork 0
mirror of https://iceshrimp.dev/limepotato/jormungandr-bite.git synced 2024-11-29 05:17:39 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: 📝 clearer package docs

Browse source
This commit is contained in:
ThatOneCalculator 2023-06-23 22:07:52 -07:00
parent 575b1eb239
commit a9463f8843
1 changed files with 5 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
packages/README.md
View file

@ -2,7 +2,8 @@
This directory contains all of the packages Calckey uses.
- `backend`: Server side code
- `client`: Web app
- `sw`: Web [Service Worker](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API)
- [`calckey-js`](https://www.npmjs.com/package/calckey-js): Global TypeScript SDK
- `backend`: Main backend code written in TypeScript for NodeJS
- `backend/native-utils`: Backend code written in Rust, bound to NodeJS by [NAPI-RS](https://napi.rs/)
- `client`: Web interface written in Vue3 and TypeScript
- `sw`: Web [Service Worker](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API) written in TypeScript
- `calckey-js`: TypeScript SDK for both backend and client, also published on [NPM](https://www.npmjs.com/package/calckey-js) for public use