it's ready to be published

README.md

@@ -1,74 +1,28 @@
-# Obsidian Sample Plugin
+# Habit Tracker 21
+Introducing "Habit Tracker 21," an innovative plugin designed specifically for Obsidian. Have you ever wanted to develop new habits but struggled to keep yourself accountable? This plugin is your perfect solution.
 
-This is a sample plugin for Obsidian (https://obsidian.md).
+"Habit Tracker 21" is built on the principle that it takes 21 days to form a new habit. With this tool, tracking your habits becomes a seamless process. It allows you to monitor your progress, providing a clear visualization of your commitment and consistency. It's a great way to motivate yourself as you see the habits you're forming over time.
 
-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.
+## How it works
+1. Create a folder for all your habits, e.g. `Habits`
+2. Create empty files inside that folder for each habit you want to track
+3. Enable the habit tracker UI. I like to past teh following in by daily todo template
 
-**Note:** The Obsidian API is still in early alpha and is subject to change at any time!
-
-This sample plugin demonstrates some of the basic functionality the plugin API can do.
-- 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.
-
-## First time developing plugins?
-
-Quick starting guide for new plugin devs:
-
-- Check if [someone already developed a plugin for what you want](https://obsidian.md/plugins)! There might be an existing plugin similar enough that you can partner up with.
-- 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.
-
-## 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. Note: The manifest.json file must be in two places, first the rootElement path of your repository and also in the release.
-- Publish the release.
-
-> You can simplify the version bump process by running `npm version patch`, `npm version minor` or `npm version major` after updating `minAppVersion` manually in `manifest.json`.
-> The command will bump version in `manifest.json` and `package.json`, and add the entry for the new version to `versions.json`
-
-## Adding your plugin to the community plugin list
-
-- Check https://github.com/obsidianmd/obsidian-releases/blob/master/plugin-review.md
-- Publish an initial version.
-- Make sure you have a `README.md` file in the rootElement of your repo.
-- Make a pull request at https://github.com/obsidianmd/obsidian-releases to add your plugin.
-
-## How to use
-
-- Clone this repo.
-- Make sure your NodeJS is at least v16 (`node --version`).
-- `npm i` or `yarn` to install dependencies.
-- `npm run dev` to start compilation in watch mode.
+~~~markdown
+```habittracker
+{
+	"path": "Habits/"
+}
+```
+~~~
 
-## Manually installing the plugin
+Make sure to specify the path you're using. You can point to one habit, or all habits that contain that path (including subfolders);
 
-- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`.
+## Example
+![Example](docs/assets/ui-demo.png)
 
-## Improve code quality with eslint (optional)
-- [ESLint](https://eslint.org/) is a tool that analyzes your code to quickly find problems. You can run ESLint against your plugin to find common bugs and ways to improve your code.
-- To use eslint with this project, make sure to install eslint from terminal:
-  - `npm install -g eslint`
-- To use eslint to analyze this project use this command:
-  - `eslint main.ts`
-  - eslint will then create a report with suggestions for code improvement by file and line number.
-- If your source code is in a folder, such as `src`, you can use eslint with this command to analyze all files in that folder:
-  - `eslint .\src\`
 
 ## Funding URL
-
 You can include funding URLs where people who use your plugin can financially support it.
 
 The simple way is to set the `fundingUrl` field to your link in your `manifest.json` file:
@@ -89,8 +43,4 @@ If you have multiple URLs, you can also do:
         "Patreon": "https://www.patreon.com/"
     }
 }
-```
-
-## API Documentation
-
-See https://github.com/obsidianmd/obsidian-api
+```

TODO.md

@@ -1,10 +1,7 @@
 ## Now
-- error handling
 
 ## Next
 - pass Today as a variable
-- readme/tutorial
-- publish it
 - link to pages
 - listen for changes and auto update
 - auto switch to new day at midnight
@@ -15,5 +12,8 @@
 - add dashboard for each habit with stats (current streak, avg streak, best streak, avg completion rate etc)
 
 ## Done
+- publish it
+- readme/tutorial
 - allow user to specify the path
-- make it work in portrait mode
+- make it work in portrait mode
+- error handling

manifest.json

@@ -1,7 +1,7 @@
 {
 	"id": "habit-tracker",
-	"name": "21 Days Habit Tracker",
-	"version": "0.3.0",
+	"name": "Habit Tracker 21",
+	"version": "1.0.0",
 	"minAppVersion": "0.15.0",
 	"description": "Your 21-day journey to habit formation simplified",
 	"author": "Zoreet",

versions.json

@@ -1,7 +1,3 @@
 {
-	"0.1.0": "0.15.0",
-	"0.1.1": "0.15.0",
-	"0.2.0": "0.15.0",
-	"0.2.1": "0.15.0",
-	"0.2.2": "0.15.0"
+	"1.0.0": "0.15.0"
 }