Edit Plugin info

README.md

@@ -1,35 +1,35 @@
-## Obsidian Sample Plugin
+## Obsidian Discord Rich Presence Plugin
 
-This is a sample plugin for Obsidian (https://obsidian.md).
+Update your Discord Status to show your friends what you are working on in Obsidian. With Discord Rich Presence.
 
-This project uses Typescript to provide type checking and documentation.
-The repo depends on the latest plugin API (obsidian.d.ts) in Typescript Definition format, which contains TSDoc comments describing what it does.
+### Usage
 
-**Note:** The Obsidian API is still in early alpha and is subject to change at any time!
+After enabling the plugin in settings, your Discord status should show that you are using Obsidian.md.
 
-### Releasing new releases
+If Discord isn't open, then you will see "Reconnect to Discord" at the botton of the screen. You can click that to attempt to reconnect. It will only connect if Discord is open.
 
-- Update your `manifest.json` with your new version number, such as `1.0.1`.
-- Create new GitHub release using your new version number as the "Tag version". Use the exact version number, don't include a prefix `v`. See here for an example: https://github.com/obsidianmd/obsidian-sample-plugin/releases
-- Upload the files `manifest.json`, `main.js`, `styles.css` as binary attachments.
-- Publish the release.
+### Features
 
-### Adding your plugin to the community plugin list
+- Updates your Discord Status with Obsidian info, **Vault Name** and/or **Current File Name**.
+- Allows you to customise what info is shown.
 
-- Publish an initial version.
-- Make sure you have a `README.md` file in the root of your repo.
-- Make a pull request at https://github.com/obsidianmd/obsidian-releases to add your plugin.
+### Settings
 
-### How to use
+- Toggle whether or not to show **Vault Name**
+- Toggle whether or not to show **Current File Name**
 
-- Clone this repo.
-- `npm i` or `yarn` to install dependencies
-- `npm run dev` to start compilation in watch mode.
+### Issues
 
-### Manually installing the plugin
+If you have any issues or suggestions please create an **issue** or a **pull request**.
 
-- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`.
+### Compatibility
+
+This plugin currently requires Obsidian v0.9.10 or above.
+
+### Install
 
-### API Documentation
+You can install the plugin via the Community Plugins tab within Obsidian.
 
-See https://github.com/obsidianmd/obsidian-api
+#### Manually installing the plugin
+
+- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`.

manifest.json

@@ -2,7 +2,7 @@
   "id": "obsidian-discordrpc",
   "name": "Discord Rich Presence",
   "version": "1.0.0",
-  "description": "Show your friends what you are working on in Obsidian. With Discord Rich Presence.",
+  "description": "Update your Discord Status to show your friends what you are working on in Obsidian. With Discord Rich Presence.",
   "author": "Luke Leppan",
   "authorUrl": "https://lukeleppan.com",
   "isDesktopOnly": false

package.json

@@ -1,7 +1,7 @@
 {
   "name": "obsidian-discordrpc",
   "version": "1.0.0",
-  "description": "Show your friends what you are working on in Obsidian. With Discord Rich Presence.",
+  "description": "Update your Discord Status to show your friends what you are working on in Obsidian. With Discord Rich Presence.",
   "main": "main.js",
   "scripts": {
     "dev": "rollup --config rollup.config.js -w",