From 48058ca739ff97059470da3b5953087e6ad12110 Mon Sep 17 00:00:00 2001 From: dat-devuap Date: Sun, 5 Jan 2025 11:05:06 +0700 Subject: [PATCH 1/5] docs(readme): remove outdated items and add details on description and setup instruction --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 205b261..a31c094 100644 --- a/README.md +++ b/README.md @@ -16,20 +16,26 @@ Plugins Server is used by some built-in plugins on Typing Mind (e.g., Web Page R Plugins Server is open-sourced and is intended to be self-hosted by individual users for private use only. +**Note**: The Plugins Server only provides an endpoint for retrieving server-side processing results. To make the plugin work, you must also install a TypingMind's plugin configured to send requests to this server endpoint. + ## 🔌 How to use (for Typing Mind users) Two simple steps: -1. Deploy this repo on any hosting provider that supports NodeJS (e.g., Render.com, AWS, etc.). (We also provide a Dockerfile for easy deployment on Docker-supported hosting providers) -2. Use the server endpoint URL in your Settings page of Typing Mind's plugins. +1. Deploy this repo on any hosting provider that supports NodeJS (e.g., Render.com, AWS, etc.). (We also provide a Dockerfile for easy deployment on Docker-supported hosting providers). +2. Install your desired TypingMind's plugin. Update the server endpoint URL in your Settings page. Follow this guide for detailed instructions: [How to Deploy Plugins Server on Render.com](https://docs.typingmind.com/plugins/plugins-server/how-to-deploy-plugins-server-on-render) +Follow this guide for setting up a TypingMind's plugin [Build a TypingMind Plugin](https://docs.typingmind.com/plugins/build-a-typingmind-plugin)) + ## List of available endpoints After deploying, visit your Plugins Server URL to see the list of available endpoints (served in Swagger UI). -Here are the latest endpoints from our public servers: https://plugins.typingmind.com/ (**Note**: this public server only hosts the API documentation. You cannot use this Public Server as your proxy. You must deploy your own Plugins Server to use all the available endpoints). +In your local development environment, visit http://localhost:3000 to access the page. + +**Note**: this public server only hosts the API documentation. You cannot use this Public Server as your proxy. You must deploy your own Plugins Server to use all the available endpoints. ## 🛠️ Development (for Typing Mind plugins developers) From 7a832e891126b0e2c6ead10db6d66cb71be8b67a Mon Sep 17 00:00:00 2001 From: dat-devuap Date: Sun, 5 Jan 2025 11:09:03 +0700 Subject: [PATCH 2/5] docs(readme): format readme --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a31c094..3f69e98 100644 --- a/README.md +++ b/README.md @@ -23,11 +23,10 @@ Plugins Server is open-sourced and is intended to be self-hosted by individual u Two simple steps: 1. Deploy this repo on any hosting provider that supports NodeJS (e.g., Render.com, AWS, etc.). (We also provide a Dockerfile for easy deployment on Docker-supported hosting providers). -2. Install your desired TypingMind's plugin. Update the server endpoint URL in your Settings page. - -Follow this guide for detailed instructions: [How to Deploy Plugins Server on Render.com](https://docs.typingmind.com/plugins/plugins-server/how-to-deploy-plugins-server-on-render) + 👉 Follow this guide for detailed instructions: [How to Deploy Plugins Server on Render.com](https://docs.typingmind.com/plugins/plugins-server/how-to-deploy-plugins-server-on-render) -Follow this guide for setting up a TypingMind's plugin [Build a TypingMind Plugin](https://docs.typingmind.com/plugins/build-a-typingmind-plugin)) +2. Install your desired TypingMind's plugin. Update the server endpoint URL in your Settings page. + 👉 Follow this guide for setting up a TypingMind's plugin [Build a TypingMind Plugin](https://docs.typingmind.com/plugins/build-a-typingmind-plugin) ## List of available endpoints From 99a5a4f8612eceb336887a031dc384aed594a73f Mon Sep 17 00:00:00 2001 From: dat-devuap Date: Sun, 5 Jan 2025 11:11:30 +0700 Subject: [PATCH 3/5] docs(readme): reformat readme --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3f69e98..b30ad88 100644 --- a/README.md +++ b/README.md @@ -23,10 +23,12 @@ Plugins Server is open-sourced and is intended to be self-hosted by individual u Two simple steps: 1. Deploy this repo on any hosting provider that supports NodeJS (e.g., Render.com, AWS, etc.). (We also provide a Dockerfile for easy deployment on Docker-supported hosting providers). - 👉 Follow this guide for detailed instructions: [How to Deploy Plugins Server on Render.com](https://docs.typingmind.com/plugins/plugins-server/how-to-deploy-plugins-server-on-render) + +👉 Follow this guide for detailed instructions: [How to Deploy Plugins Server on Render.com](https://docs.typingmind.com/plugins/plugins-server/how-to-deploy-plugins-server-on-render) 2. Install your desired TypingMind's plugin. Update the server endpoint URL in your Settings page. - 👉 Follow this guide for setting up a TypingMind's plugin [Build a TypingMind Plugin](https://docs.typingmind.com/plugins/build-a-typingmind-plugin) + +👉 Follow this guide for setting up a TypingMind's plugin [Build a TypingMind Plugin](https://docs.typingmind.com/plugins/build-a-typingmind-plugin) ## List of available endpoints From 866bd59d3b136ae428736e16aca87a1b04f0b7d7 Mon Sep 17 00:00:00 2001 From: dat-devuap Date: Sun, 5 Jan 2025 11:12:41 +0700 Subject: [PATCH 4/5] docs(readme): reformat readme --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b30ad88..5ff7dcc 100644 --- a/README.md +++ b/README.md @@ -24,10 +24,10 @@ Two simple steps: 1. Deploy this repo on any hosting provider that supports NodeJS (e.g., Render.com, AWS, etc.). (We also provide a Dockerfile for easy deployment on Docker-supported hosting providers). -👉 Follow this guide for detailed instructions: [How to Deploy Plugins Server on Render.com](https://docs.typingmind.com/plugins/plugins-server/how-to-deploy-plugins-server-on-render) - 2. Install your desired TypingMind's plugin. Update the server endpoint URL in your Settings page. +👉 Follow this guide for detailed instructions: [How to Deploy Plugins Server on Render.com](https://docs.typingmind.com/plugins/plugins-server/how-to-deploy-plugins-server-on-render) + 👉 Follow this guide for setting up a TypingMind's plugin [Build a TypingMind Plugin](https://docs.typingmind.com/plugins/build-a-typingmind-plugin) ## List of available endpoints From d0e6d4e7b6ae6c5a629548287ca0f500789a9302 Mon Sep 17 00:00:00 2001 From: dat-devuap Date: Sun, 5 Jan 2025 11:14:21 +0700 Subject: [PATCH 5/5] docs(readme): reformat readme --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5ff7dcc..6005bbf 100644 --- a/README.md +++ b/README.md @@ -26,9 +26,9 @@ Two simple steps: 2. Install your desired TypingMind's plugin. Update the server endpoint URL in your Settings page. -👉 Follow this guide for detailed instructions: [How to Deploy Plugins Server on Render.com](https://docs.typingmind.com/plugins/plugins-server/how-to-deploy-plugins-server-on-render) +Follow this guide for detailed instructions: [How to Deploy Plugins Server on Render.com](https://docs.typingmind.com/plugins/plugins-server/how-to-deploy-plugins-server-on-render) -👉 Follow this guide for setting up a TypingMind's plugin [Build a TypingMind Plugin](https://docs.typingmind.com/plugins/build-a-typingmind-plugin) +Follow this guide for setting up a TypingMind's plugin: [Build a TypingMind Plugin](https://docs.typingmind.com/plugins/build-a-typingmind-plugin) ## List of available endpoints