From a9463f88439b7a2dc8a0f50aced17823bcbc2a3e Mon Sep 17 00:00:00 2001 From: ThatOneCalculator Date: Fri, 23 Jun 2023 22:07:52 -0700 Subject: [PATCH] docs: :memo: clearer package docs --- packages/README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/packages/README.md b/packages/README.md index 75a66b12f..7d7c03e0b 100644 --- a/packages/README.md +++ b/packages/README.md @@ -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