Prepare to publish

README.md

@@ -1,96 +1,31 @@
-# Obsidian Sample Plugin
 
-This is a sample plugin for Obsidian (https://obsidian.md).
+> Save data directly to Obsidian with specified template. Capture from Telegram, WhatsApp, Slack, Email, SMS, Raycast and more.
 
-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.
+## Hints Flow plugin
 
-**Note:** The Obsidian API is still in early alpha and is subject to change at any time!
+A [Hints](https://hints.so/) quick-capturing plugin for [Obsidian](https://obsidian.md/).
 
-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.
+You can save data directly to Obsidian with specified template from Telegram, WhatsApp, Slack, Email, SMS, Raycast and more.
 
-## First time developing plugins?
+Learn more about Hints integrations with Notion, Calendar, ClickUp, Trello, HubSpot, Pipedrive and Jira.
 
-Quick starting guide for new plugin devs:
+![Video overview](Hints–Obsidian.gif)
 
-- 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.
+### How to install
 
-## Releasing new releases
+- Install the Hints Flow plugin form Obsidian marketplace or manually
+    - for manual installation copy `hints-plugin` folder from the latest [releases](https://github.com/slpbx/obsidian-plugin/releases/latest) to your vault's plugins folder, under `[YourVaultFolder]/.obsidian/plugins/`.
+    - to show hidden files open the Finder and press `Command + Shift + . (period)`
+- Go to [Hints Web App](https://i.hints.so/) and create free account
+- `Create new flow` and select Obsidian
+- Choose one or more sources of knowledge capturing
+- Select the tag that will be used for capturing (default `#obsidian`)
+- Click `Connect Obsidian`, setup file to append or daily note
+- Go back to Hints app and click `Publish flow`
 
-- 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 root path of your repository and also in the release.
-- Publish the release.
+### How to use
+- Forward or send any message to Hints bot via Telegram, WhatsApp or Slack
+- Send via Email, SMS or capture with RayCast
+- Review advances use-cases and examples on [Hints.so](https://hints.so/flows)
 
-> 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 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/`.
-
-## 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:
-
-```json
-{
-    "fundingUrl": "https://buymeacoffee.com"
-}
-```
-
-If you have multiple URLs, you can also do:
-
-```json
-{
-    "fundingUrl": {
-        "Buy Me a Coffee": "https://buymeacoffee.com",
-        "GitHub Sponsor": "https://github.com/sponsors",
-        "Patreon": "https://www.patreon.com/"
-    }
-}
-```
-
-## API Documentation
-
-See https://github.com/obsidianmd/obsidian-api
+> Don’t just store knowledge, move it forward!

main.ts

@@ -23,7 +23,7 @@ interface HintsSettings {
 const DEFAULT_SETTINGS: HintsSettings = {
     appendToDailyNote: false,
     appendPath: null,
-    appendTemplate: '\n---\n#### {{date}}\n{{content}}',
+    appendTemplate: '\n---\n#### captured [[{{date}}]] at `{{time}}`\n\n{{content}}\n',
     dateFormat: 'YYYY-MM-DD [at] HH:mm',
     timeFormat: 'HH:mm',
     showInStatusBar: true,

manifest.json

@@ -1,10 +1,10 @@
 {
 	"id": "hints-plugin",
-	"name": "Hints",
-	"version": "1.0.1",
+	"name": "Hints Flow",
+	"version": "1.0.2",
 	"minAppVersion": "0.15.0",
-	"description": "This is a sample plugin for Obsidian. This plugin demonstrates some of the capabilities of the Obsidian API.",
+	"description": "Save data directly to Obsidian with specified template. Capture from Telegram, WhatsApp, Slack, Email, SMS, Raycast and more.",
 	"author": "Hints",
 	"authorUrl": "https://hints.so",
 	"isDesktopOnly": false
-}
+}

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "obsidian-sample-plugin",
-	"version": "1.0.1",
+	"version": "1.0.2",
 	"description": "This is a sample plugin for Obsidian (https://obsidian.md)",
 	"main": "main.js",
 	"scripts": {

src/AuthModal.ts

@@ -51,7 +51,7 @@ export class AuthModal extends Modal {
             contentEl.createEl('p', { text: 'Looks like authorization token is expired. Please try again' });
         } else if (this._connected) {
             contentEl.createEl('p', { text: 'You have successfully connected to Hints!' });
-            contentEl.createEl('p', { text: 'Now continue to the Hints website' });
+            contentEl.createEl('p', { text: 'Go back to Hints app and click `Publish Flow`' });
         }else {
             contentEl.createEl('p', { text: 'Loading...' });
         }

src/HintsSettingTab.ts

@@ -40,6 +40,7 @@ export class HintsSettingTab extends PluginSettingTab {
                     cb.setButtonText("Logout")
                         .onClick(async () => {
                             await auth.signOut()
+                            this.display();
                         });
                 });
 
@@ -103,7 +104,7 @@ export class HintsSettingTab extends PluginSettingTab {
                 .then(cb => {
                     cb.inputEl.style.minWidth = '100%';
                     cb.inputEl.style.maxWidth = '100%';
-                    cb.inputEl.style.minHeight = '80px';
+                    cb.inputEl.style.minHeight = '100px';
                 })
 
             new Setting(containerEl)

versions.json

@@ -1,3 +1,5 @@
 {
-	"1.0.0": "0.15.0"
-}
+	"1.0.0": "0.15.0",
+	"1.0.1": "0.15.0",
+	"1.0.2": "0.15.0"
+}