Fix janhq#290: Add description in package.json and rename to jan (jan…

…hq#333)

Co-authored-by: Hien To <[email protected]>

README.md

@@ -73,7 +73,7 @@ To reset your installation:
 1. Delete Jan Application from /Applications
 
 1. Clear cache:
-`rm -rf /Users/$(whoami)/Library/Application\ Support/jan-electron`
+`rm -rf /Users/$(whoami)/Library/Application\ Support/jan`
 OR 
 `rm -rf /Users/$(whoami)/Library/Application\ Support/jan`
 

electron/package.json

@@ -1,10 +1,11 @@
 {
-  "name": "jan-electron",
+  "name": "jan",
   "version": "0.1.3",
   "main": "./build/main.js",
   "author": "Jan <[email protected]>",
   "license": "MIT",
-  "homepage": "./",
+  "homepage": "https://github.com/janhq/jan/tree/main/electron",
+  "description": "Use offline LLMs with your own data. Run open source models like Llama2 or Falcon on your internal computers/servers.",
   "build": {
     "appId": "jan.ai.app",
     "productName": "Jan",

electron/tests/main.e2e.spec.ts

@@ -22,9 +22,9 @@ test.beforeAll(async () => {
   expect(appInfo.asar).toBe(true);
   expect(appInfo.executable).toBeTruthy();
   expect(appInfo.main).toBeTruthy();
-  expect(appInfo.name).toBe("jan-electron");
+  expect(appInfo.name).toBe("jan");
   expect(appInfo.packageJson).toBeTruthy();
-  expect(appInfo.packageJson.name).toBe("jan-electron");
+  expect(appInfo.packageJson.name).toBe("jan");
   expect(appInfo.platform).toBeTruthy();
   expect(appInfo.platform).toBe(process.platform);
   expect(appInfo.resourcesDir).toBeTruthy();

package.json

@@ -14,23 +14,23 @@
     ]
   },
   "scripts": {
-    "lint": "yarn workspace jan-electron lint && yarn workspace jan-web lint",
-    "test": "yarn workspace jan-electron test:e2e",
-    "dev:electron": "yarn workspace jan-electron dev",
+    "lint": "yarn workspace jan lint && yarn workspace jan-web lint",
+    "test": "yarn workspace jan test:e2e",
+    "dev:electron": "yarn workspace jan dev",
     "dev:web": "yarn workspace jan-web dev",
     "dev": "concurrently --kill-others \"yarn dev:web\" \"wait-on http://localhost:3000 && yarn dev:electron\"",
     "build:web": "yarn workspace jan-web build && cpx \"web/out/**\" \"electron/renderer/\"",
-    "build:electron": "yarn workspace jan-electron build",
+    "build:electron": "yarn workspace jan build",
     "build:plugins": "rimraf ./electron/core/pre-install/*.tgz && concurrently \"cd ./electron/core/plugins/data-plugin && npm ci\" \"cd ./electron/core/plugins/inference-plugin && npm ci\" \"cd ./electron/core/plugins/model-management-plugin && npm ci\" \"cd ./electron/core/plugins/monitoring-plugin && npm ci\" && concurrently \"cd ./electron/core/plugins/data-plugin && npm run build:publish\" \"cd ./electron/core/plugins/inference-plugin && npm run build:publish\" \"cd ./electron/core/plugins/model-management-plugin && npm run build:publish\" \"cd ./electron/core/plugins/monitoring-plugin && npm run build:publish\"",
     "build:plugins-darwin": "rimraf ./electron/core/pre-install/*.tgz && concurrently \"cd ./electron/core/plugins/data-plugin && npm ci\" \"cd ./electron/core/plugins/inference-plugin && npm ci\" \"cd ./electron/core/plugins/model-management-plugin && npm ci\" \"cd ./electron/core/plugins/monitoring-plugin && npm ci\" && chmod +x ./electron/auto-sign.sh && ./electron/auto-sign.sh && concurrently \"cd ./electron/core/plugins/data-plugin && npm run build:publish\" \"cd ./electron/core/plugins/inference-plugin && npm run build:publish\" \"cd ./electron/core/plugins/model-management-plugin && npm run build:publish\" \"cd ./electron/core/plugins/monitoring-plugin && npm run build:publish\"",
     "build": "yarn build:web && yarn build:electron",
-    "build:darwin": "yarn build:web && yarn workspace jan-electron build:darwin",
-    "build:win32": "yarn build:web && yarn workspace jan-electron build:win32",
-    "build:linux": "yarn build:web && yarn workspace jan-electron build:linux",
-    "build:publish": "yarn build:web && yarn workspace jan-electron build:publish",
-    "build:publish-darwin": "yarn build:web && yarn workspace jan-electron build:publish-darwin",
-    "build:publish-win32": "yarn build:web && yarn workspace jan-electron build:publish-win32",
-    "build:publish-linux": "yarn build:web && yarn workspace jan-electron build:publish-linux"
+    "build:darwin": "yarn build:web && yarn workspace jan build:darwin",
+    "build:win32": "yarn build:web && yarn workspace jan build:win32",
+    "build:linux": "yarn build:web && yarn workspace jan build:linux",
+    "build:publish": "yarn build:web && yarn workspace jan build:publish",
+    "build:publish-darwin": "yarn build:web && yarn workspace jan build:publish-darwin",
+    "build:publish-win32": "yarn build:web && yarn workspace jan build:publish-win32",
+    "build:publish-linux": "yarn build:web && yarn workspace jan build:publish-linux"
   },
   "devDependencies": {
     "concurrently": "^8.2.1",