Finalised the first beta version

MaelImhof · May 7, 2024 · 2918fc7 · 2918fc7
1 parent 4cc6260
commit 2918fc7
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 2 deletions.
diff --git a/docs/content/add-beta-plugin.png b/docs/content/add-beta-plugin.png
diff --git a/docs/content/images/popup-add-plugin.png b/docs/content/images/popup-add-plugin.png
diff --git a/docs/content/settings.md → docs/content/images/settings.md b/docs/content/settings.md → docs/content/images/settings.md
diff --git a/docs/content/images/setup-done.png b/docs/content/images/setup-done.png
diff --git a/docs/content/index.md b/docs/content/index.md
@@ -23,7 +23,21 @@ This Obsidian plugin is entering beta now. I want to gather feedback and improve
 
 ## Installing the plugin
 
-> [!TODO] Do this installing plugin with BRAT section
+Because Jupyter for Obsidian is not available in the Obsidian community plugins for now, you'll need the [BRAT plugin](https://tfthacker.com/brat-quick-guide#Stopping%20beta%20plugin%20updates/deleting%20a%20beta%20plugin) to install Jupyter for Obsidian.
+
+Here is how to proceed :
+
+1. Backup your vault!
+2. Install the [BRAT](https://github.com/TfTHacker/obsidian42-brat) plugin from the Obsidian community plugins.
+3. Go in BRAT settings and click `Add Beta plugin`
+
+   ![[add-beta-plugin.png]]
+4. Use `https://github.com/MaelImhof/obsidian-jupyter` as the URL, tick `Enable after installing the plugin` and click `Add Plugin`.
+
+   ![[popup-add-plugin.png]]
+5. Voilà! The plugin should now be installed in your vault. Use it as a normal plugin and **provide feedback** about the beta.
+
+   ![[setup-done.png]]
 ## Providing Feedback
 
 Once the plugin is installed, you can start using it normally in your Obsidian vault. Discover the [[discover|features of the plugin]] and try playing a bit with it, see how it integrates with your workflow.

diff --git a/manifest-beta.json b/manifest-beta.json
@@ -1,7 +1,7 @@
 {
 	"id": "jupyter",
 	"name": "Jupyter",
-	"version": "0.2.1-beta",
+	"version": "0.3.0-beta",
 	"minAppVersion": "0.15.0",
 	"description": "Open .ipynb files with Jupyter in Obsidian.",
 	"author": "Maël Imhof",