Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme #65

Merged
merged 5 commits into from
Jan 5, 2025
+10 −3
Merged

Update readme #65

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
48058ca
docs(readme): remove outdated items and add details on description an…
dat-devuap Jan 5, 2025
7a832e8
docs(readme): format readme
dat-devuap Jan 5, 2025
99a5a4f
docs(readme): reformat readme
dat-devuap Jan 5, 2025
866bd59
docs(readme): reformat readme
dat-devuap Jan 5, 2025
d0e6d4e
docs(readme): reformat readme
dat-devuap Jan 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,20 +16,27 @@ 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)

Expand Down
Loading