From 5dcd1b12dbaddd2e21bb59d4304978ec30e16474 Mon Sep 17 00:00:00 2001 From: Mulverine Date: Fri, 10 May 2024 22:11:32 -0600 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=84=20Update=20README?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 12 +++++------- packages/client-cli/package.json | 23 ----------------------- packages/client-cli/src/index.ts | 0 packages/client-cli/tsconfig.json | 0 4 files changed, 5 insertions(+), 30 deletions(-) delete mode 100755 packages/client-cli/package.json delete mode 100755 packages/client-cli/src/index.ts delete mode 100755 packages/client-cli/tsconfig.json diff --git a/README.md b/README.md index 468a33b..d2758ec 100644 --- a/README.md +++ b/README.md @@ -41,16 +41,14 @@ Hosting server for addons (plugins & themes). - Written in TypeScript. - Support for several deployments; CLI, Docker, NPM/Embedded, CloudFlare Worker/Edge, etc. -### [client-cli](/packages/client-cli) -Testing client for development of core. - ### [client-flutter](/packages/client-flutter) Cross-platform UI. (All platforms) +- Directly embeds `core` & all plugins using https://github.com/openwebf/mercury. ### [core](/packages/core) All internal functionality code. Requires codec compatibility info and implemented native user input & playback hooks. - Written in TypeScript. -- Releases will include compatible bundles for Node 18 & Latest Deno/Bun. +- Releases via compiled https://github.com/openwebf/quickjs bytecode targeting https://github.com/openwebf/mercury. - Will use Refracture [Intern](https://github.com/RefractureMedia/intern) to provide [SponsorBlock](https://github.com/ajayyy/SponsorBlock) style crowd-sourced submissions to simplify, optimize, & enrich music metadata. ### [docs](/packages/docs) @@ -59,12 +57,12 @@ Markdown documentation of the project. ### [server](/packages/server) A self-hosted session & library dameon/service. Provides a centralized location for syncing your profile between devices and streaming/distributing your saved library. - Written in TypeScript. -- A runtime agnostic CLI with Linux tooling & windows support (through the app). +- A Bun CLI with Linux tooling & windows support (via the client). -### [web](/packages/addon-host) +### [web](/packages/web) Hosting server for the project. - Written in TypeScript. -- Support for several deployments; Vercel, Docker, etc. +- Deploys via Docker, powered by Bun. - Includes a website written in [Vue](https://vuejs.org/guide/introduction.html)/[Nuxt](https://v3.nuxtjs.org/guide/concepts/introduction) 3. ## Official Plugins diff --git a/packages/client-cli/package.json b/packages/client-cli/package.json deleted file mode 100755 index cd3cdbf..0000000 --- a/packages/client-cli/package.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "name": "@refracturemedia/music-client-cli", - "private": true, - "version": "0.1.0", - "description": "A barebones CLI to rapidly test & develop music-core", - "main": "lib/index.js", - "scripts": { - "test": "echo \"Error: no test specified\" && exit 1" - }, - "repository": { - "type": "git", - "url": "git+https://github.com/RefractureMedia/refracture-music.git" - }, - "author": "MulverineX", - "license": "MIT", - "bugs": { - "url": "https://github.com/RefractureMedia/refracture-music/issues" - }, - "homepage": "https://github.com/RefractureMedia/refracture-music#readme", - "devDependencies": { - "typescript": "^4.7.2" - } -} diff --git a/packages/client-cli/src/index.ts b/packages/client-cli/src/index.ts deleted file mode 100755 index e69de29..0000000 diff --git a/packages/client-cli/tsconfig.json b/packages/client-cli/tsconfig.json deleted file mode 100755 index e69de29..0000000