diff --git a/docs/docs/getting-started/build-an-app.md b/docs/docs/getting-started/build-an-app.md index 343605011..21834939b 100644 --- a/docs/docs/getting-started/build-an-app.md +++ b/docs/docs/getting-started/build-an-app.md @@ -101,12 +101,4 @@ So, what are you waiting for? Go ahead and start customizing your plugin! To be updated ## App update -To be updated - -## App publish -After you have completed with local app development and want to publish to `Jan marketplace` for other to reuse, please follow the following steps -- Update your local `package.json` and configure `npm login` correctly -- Run `npm publish` and set to public NPM package (so that other can install) - Please refer to our example [NPM retrieval plugin](https://www.npmjs.com/package/retrieval-plugin) -- Go to `Jan plugin catalog`(https://github.com/janhq/plugin-catalog) and create a `Pull request` for new `App artifact` (which is a renamed version of your App `package.json`) - Please refer to example [retrieval-plugin](https://github.com/janhq/plugin-catalog/blob/main/retrieval-plugin.json) -- We at Jan will be responsible to review and merge to `main` -- Once your new app is on `main`, you and other Jan users can find it in `Jan marketplace` \ No newline at end of file +To be updated \ No newline at end of file diff --git a/docs/docs/tutorials/publish-jan-app.md b/docs/docs/tutorials/publish-jan-app.md index 9209be9e4..f0ef0bc24 100644 --- a/docs/docs/tutorials/publish-jan-app.md +++ b/docs/docs/tutorials/publish-jan-app.md @@ -3,4 +3,10 @@ sidebar_position: 3 title: Publishing a Jan app --- -TODO +# Publish Jan app +After you have completed with local app development and want to publish to `Jan marketplace` for other to reuse, please follow the following steps +- Step 1: Update your local `package.json` and configure `npm login` correctly +- Step 2: Run `npm publish` and set to public NPM package (so that other can install) - Please refer to our example [NPM retrieval plugin](https://www.npmjs.com/package/retrieval-plugin) +- Step 3: Go to `Jan plugin catalog`(https://github.com/janhq/plugin-catalog) and create a `Pull request` for new `App artifact` (which is a renamed version of your App `package.json`) - Please refer to example [retrieval-plugin](https://github.com/janhq/plugin-catalog/blob/main/retrieval-plugin.json) +- Step 4: We at Jan will be responsible to review and merge to `main` +- Step 5: Once your new app is on `main`, you and other Jan users can find it in `Jan marketplace`