docs: 📝 document packages dir

This commit is contained in:
ThatOneCalculator 2023-06-23 22:00:29 -07:00
parent ff71963414
commit 62efd07ca0
No known key found for this signature in database
GPG key ID: 8703CACD01000000
2 changed files with 10 additions and 2 deletions

8
packages/README.md Normal file
View file

@ -0,0 +1,8 @@
# 📦 Packages
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

View file

@ -1,6 +1,6 @@
{ {
"name": "calckey-js", "name": "calckey-js",
"version": "0.0.23", "version": "0.0.24",
"description": "Calckey SDK for JavaScript", "description": "Calckey SDK for JavaScript",
"main": "./built/index.js", "main": "./built/index.js",
"types": "./built/index.d.ts", "types": "./built/index.d.ts",
@ -18,7 +18,7 @@
}, },
"repository": { "repository": {
"type": "git", "type": "git",
"url": "https://codeberg.org/calckey/calckey.js" "url": "https://codeberg.org/calckey/calckey.git"
}, },
"devDependencies": { "devDependencies": {
"@microsoft/api-extractor": "^7.36.0", "@microsoft/api-extractor": "^7.36.0",