diff --git a/packages/embeds/embed-core/README.md b/packages/embeds/embed-core/README.md index bd1e76dcb1..9234286dce 100644 --- a/packages/embeds/embed-core/README.md +++ b/packages/embeds/embed-core/README.md @@ -1,10 +1,12 @@ # embed-core -See [index.html](index.html) to see various examples +This is the vanilla JS core script that embeds Cal Link. ## How to use embed on any webpage no matter what framework See +You can also see various example usages [here](https://github.com/calcom/cal.com/blob/main/packages/embeds/embed-core/index.html) + ## Development Run the following command and then you can test the embed in the automatically opened page `http://localhost:3002` diff --git a/packages/embeds/embed-core/package.json b/packages/embeds/embed-core/package.json index bb8a747149..dc8896990c 100644 --- a/packages/embeds/embed-core/package.json +++ b/packages/embeds/embed-core/package.json @@ -1,7 +1,7 @@ { "name": "@calcom/embed-core", - "version": "0.1.0", - "description": "The core script adds the booking embed", + "version": "1.0.0", + "description": "This is the vanilla JS core script that embeds Cal Link", "main": "./index.ts", "scripts": { "build": "vite build", diff --git a/packages/embeds/embed-react/README.md b/packages/embeds/embed-react/README.md index 72880c852d..5463129da1 100644 --- a/packages/embeds/embed-react/README.md +++ b/packages/embeds/embed-react/README.md @@ -1,7 +1,5 @@ # cal-react -Makes the embed available as a React component. +Embed Cal Link as a React Component -To add the embed on a webpage built using React. Follow the steps - -See docs.cal.com/integrations/embed \ No newline at end of file +To know how to use it, follow the steps at \ No newline at end of file diff --git a/packages/embeds/embed-react/package.json b/packages/embeds/embed-react/package.json index 26693a53c5..2bc54947e9 100644 --- a/packages/embeds/embed-react/package.json +++ b/packages/embeds/embed-react/package.json @@ -1,7 +1,7 @@ { "name": "@calcom/embed-react", - "version": "0.1.0", - "description": "Embed Cal Booking anywhere", + "version": "1.0.0", + "description": "Embed Cal Link as a React Component", "scripts": { "dev": "vite --port=3003 --open", "build": "vite build", @@ -10,6 +10,9 @@ "lint": "eslint --ext .ts,.js,.tsx,.jsx ./src" }, "main": "src/Cal.tsx", + "dependencies": { + "@calcom/embed-snippet": "^1.0.0" + }, "devDependencies": { "vite": "^2.8.6", "eslint": "^8.10.0" diff --git a/packages/embeds/embed-snippet/README.md b/packages/embeds/embed-snippet/README.md index 0bde031132..0dab1a403b 100644 --- a/packages/embeds/embed-snippet/README.md +++ b/packages/embeds/embed-snippet/README.md @@ -1,6 +1,6 @@ # embed-snippet -This is the code snippet that is to be installed by the user on his website. +Vanilla JS embed snippet that is responsible to fetch @calcom/embed-core and thus show Cal Link as an embed on a page. ## Development diff --git a/packages/embeds/embed-snippet/package.json b/packages/embeds/embed-snippet/package.json index edc3458df5..f559564133 100644 --- a/packages/embeds/embed-snippet/package.json +++ b/packages/embeds/embed-snippet/package.json @@ -1,7 +1,8 @@ { "name": "@calcom/embed-snippet", - "version": "0.1.0", + "version": "1.0.0", "main": "src/index.ts", + "description": "Vanilla JS embed snippet that is responsible to fetch @calcom/embed-core and thus show Cal Link as an embed on a page.", "scripts": { "build": "vite build", "type-check": "tsc --pretty --noEmit",