natty
/
calckey
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: 📝 clearer package docs

This commit is contained in:
ThatOneCalculator 2023-06-23 22:07:52 -07:00
parent 62efd07ca0
commit 6e364a857f
No known key found for this signature in database
GPG Key ID: 8703CACD01000000
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. This directory contains all of the packages Calckey uses.
- `backend`: Server side code - `backend`: Main backend code written in TypeScript for NodeJS
- `client`: Web app - `backend/native-utils`: Backend code written in Rust, bound to NodeJS by [NAPI-RS](https://napi.rs/)
- `sw`: Web [Service Worker](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API) - `client`: Web interface written in Vue3 and TypeScript
- [`calckey-js`](https://www.npmjs.com/package/calckey-js): Global TypeScript SDK - `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