diff --git a/README.md b/README.md index 81bdb8f..5713297 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,9 @@ # obsidian-gamified-pkm -[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/J3J6DYYS5) - ## **🌟 Elevate Your Knowledge Management with the Obsidian Gamification Plugin! 🚀** Hello, fellow learners and knowledge seekers! 📚 If you're as passionate about personal growth as I am, and you believe that motivation is the key to unlocking new horizons, then you're in for something special. -[find the manual installation advice here](https://github.com/saertna/obsidian-gamified-pkm#manual-installation) - ## Hey there! 👋 Imagine transforming your knowledge management into an adventure where every step forward is a celebration. Introducing the Obsidian Gamification Plugin – a tool designed to harness the motivating power of game techniques and apply it to our pursuit of knowledge. @@ -33,19 +29,17 @@ If you resonate with the idea of infusing motivational game techniques into pers Thank you for being a part of this movement to revolutionize our approach to knowledge management. Let's harness the power of motivation and level up our learning journey together! 🌐🌱 -## Manual installation +## Installation +Follow the steps below to install 'Gamificate your PKM'. -1. Download the latest release 🔗 **Plugin Download:** [Obsidian Gamification Plugin](https://github.com/saertna/obsidian-gamified-pkm/releases/tag/0.0.85) -2. Extract the obsidian-gamified-pkm folder from the zip to your vault's plugins folder: ``/.obsidian/plugins/ - - Note: On some machines the .obsidian folder may be hidden. On MacOS you should be able to press Command+Shift+Dot to show the folder in Finder. - - Note: the files `main.js` and `manifest.json` are the files which you need in this folder. -3. Reload Obsidian -4. If prompted about Safe Mode, you can disable safe mode and enable the plugin. -5. plugins needed to be installed - - `dataview`. In dataview settings enable `Enable JavaScript Queries` and `Enable Inline JavaScript Queries` to display counting in profile. - - `obsidian-charts` -6. in Obsidian hit `CTRL+P` and run command `Initialize gamification ratings` -7. create and improve notes and rate again to increase points +1. Search for "Gamificate your PKM" in Obsidian's community plugins browser +2. Enable the plugin in your Obsidian settings (find "Gamificate your PKM" under "Community plugins"). +3. Check the settings. Maybe you would like to exclute TAGs (more about it below). +4. plugins needed to be installed and configured for fully operational + - `dataview`. In dataview settings enable `Enable JavaScript Queries` and `Enable Inline JavaScript Queries` to display counting in profile. + - `obsidian-charts` +5. in Obsidian hit `CTRL+P` and run command `Initialize gamification ratings` +6. create and improve notes and rate again to increase points **Embark on a Motivational Journey!** @@ -93,4 +87,4 @@ Upcoming developments are in store for the Gamification Plugin! Here's a glimpse - add further badges for achievements - implement check if update of plugin is available - new challenges -- Quests to follow and fulfill \ No newline at end of file +- Quests to follow and fulfill