refactor: add files for release

README.md

@@ -1,57 +1,20 @@
-## Obsidian Sample Plugin
+# Obsidian Icon Folder
 
-This is a sample plugin for Obsidian (https://obsidian.md).
+This obsidian plugin allows you to add icons to your folder.
 
-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.
+Right now, the current iconsets are available:
+* [Remixicon](https://remixicon.com/)
 
-**Note:** The Obsidian API is still in early alpha and is subject to change at any time!
+## Screenshots
 
-This sample plugin demonstrates some of the basic functionality the plugin API can do.
-- Changes the default font color to red using `styles.css`.
-- Adds a ribbon icon, which shows a Notice when clicked.
-- Adds a command "Open Sample Modal" which opens a Modal.
-- Adds a plugin setting tab to the settings page.
-- Registers a global click event and output 'click' to the console.
-- Registers a global interval which logs 'setInterval' to the console.
+Here is one way to 
 
-### First time developing plugins?
+## How to use
 
-Quick starting guide for new plugin devs:
+It is pretty simple to add a icon to your folder:
 
-- Make a copy of this repo as a template with the "Use this template" button (login to GitHub if you don't see it).
-- Clone your repo to a local development folder. For convenience, you can place this folder in your `.obsidian/plugins/your-plugin-name` folder.
-- Install NodeJS, then run `npm i` in the command line under your repo folder.
-- Run `npm run dev` to compile your plugin from `main.ts` to `main.js`.
-- Make changes to `main.ts` (or create new `.ts` files). Those changes should be automatically compiled into `main.js`.
-- Reload Obsidian to load the new version of your plugin.
-- Enable plugin in settings window.
-- For updates to the Obsidian API run `npm update` in the command line under your repo folder.
+1. Right click on the folder where you want to add an icon
+2. Select the `Change Icon` menu item (prefixed with a `#` icon)
+3. Select the icon you want and profit!
 
-### Releasing new releases
-
-- Update your `manifest.json` with your new version number, such as `1.0.1`, and the minimum Obsidian version required for your latest release.
-- Update your `versions.json` file with `"new-plugin-version": "minimum-obsidian-version"` so older versions of Obsidian can download an older version of your plugin that's compatible.
-- 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.
-
-### Adding your plugin to the community plugin list
-
-- 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.
-
-### How to use
-
-- Clone this repo.
-- `npm i` or `yarn` to install dependencies
-- `npm run dev` to start compilation in watch mode.
-
-### Manually installing the plugin
-
-- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`.
-
-### API Documentation
-
-See https://github.com/obsidianmd/obsidian-api
+To delete an icon, you just need to click on the `Delete Icon` (prefixed with a `trash` icon) menu item.

manifest.json

@@ -1,10 +1,10 @@
 {
-	"id": "obsidian-icon-folder",
-	"name": "Icon Folder",
-	"version": "0.1.0",
-	"minAppVersion": "0.9.12",
-	"description": "This plugin allows to add an emoji in front of a folder.",
-	"author": "Florian Woelki",
-	"authorUrl": "https://florianwoelki.com/",
-	"isDesktopOnly": false
+  "id": "obsidian-icon-folder",
+  "name": "Icon Folder",
+  "version": "1.0.0",
+  "minAppVersion": "0.9.12",
+  "description": "This plugin allows to add an emoji in front of a folder.",
+  "author": "Florian Woelki",
+  "authorUrl": "https://florianwoelki.com/",
+  "isDesktopOnly": false
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "obsidian-icon-folder",
-  "version": "0.1.0",
+  "version": "1.0.0",
   "description": "This is an obsidian plugin that allows us to use an icon in the prefix of a folder name.",
   "main": "main.js",
   "scripts": {

versions.json

@@ -1,4 +1,3 @@
 {
-	"1.0.1": "0.9.12",
-	"1.0.0": "0.9.7"
+  "1.0.0": "0.9.12"
 }