From 60f630344525f81f809d471a00f85c15e4122673 Mon Sep 17 00:00:00 2001
From: Castro Crea <castro.crea@gmail.com>
Date: Sat, 20 Apr 2024 18:56:18 +0200
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Add=20documentation?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md                 | 54 +++++++++++++++------------------------
 doc/Plugin_Development.md | 37 +++++++++++++++++++++++++++
 src/index.ts              |  2 +-
 3 files changed, 59 insertions(+), 34 deletions(-)
 create mode 100644 doc/Plugin_Development.md

diff --git a/README.md b/README.md
index 2c20a99..bc121d1 100644
--- a/README.md
+++ b/README.md
@@ -1,33 +1,21 @@
-# Doc
-
-```bash
-npm pub 
-// or 
-npm run build
-npm publish
-```
-
-# Develop on Moon
-
-Add this with the path to your plugins
-```json
-{
-  "id": 40,
-  "packageName": "PATH_TP_YOUR_PLUGINS/moon-notion-plugin",
-  "description": "Notion app",
-  "fromPath": true, 
-  "devMode": true, 
-  "npmRegistryUrl": "https://npm.pkg.github.com",
-  "npmRegistryConfig": {
-    "auth": {
-      "token": "GITHUB_TOKEN_IF_DEV_PRIVATE"
-    }
-  }
-}
-```
-
-Run `yarn watch` in your plugin root, it will be auto build.
-Open the settings to update the plugin
-Then open the launcher to test it
-You can also check the logs if you use them here
-Use moon.log in `/Users/paolocastro/Library/Application Support/test-paolo-2/moon.log`
\ No newline at end of file
+# Moon Jot
+
+Revolutionize your note-taking workflow with Moon Jot: an intelligent launcher that combines fast typing with AI-driven context capture, customizable plugins, and seamless integration like Notion, Obsidian, ... - all designed to boost productivity and creativity!
+
+## Concept 
+
+Moon Jot is revolutionizing note-taking by offering users access to an intelligent launcher through a simple universal shortcut. 
+
+This launcher provides a fluid and customizable text editor, enabling fast and efficient typing. But that's not all: thanks to our API integration via customizable plugins, notes can be instantly sent to tools like Notion or Obsidian. 
+
+Moon Jot stands out by its ability to capture the user's context, providing relevant information such as document titles and authors, or even details from social media platforms like Twitter and LinkedIn. 
+
+Currently available on Mac OS X, our solution is designed to adapt to every workflow through customizable plugins. Moreover, our integrated artificial intelligence allow you a way more customizable prompt interaction than any GPT on the market, thus enhancing the productivity and creativity of our users. 
+
+Moon Jot offers an unparalleled note-taking experience, combining ease of use with advanced features and extensive customization. Join us in reinventing how we capture and utilize information in our daily lives.
+
+## Videos
+
+## Documentation
+
+[Plugin Development]('./doc/Plugin_Development.md)
diff --git a/doc/Plugin_Development.md b/doc/Plugin_Development.md
new file mode 100644
index 0000000..2f36f86
--- /dev/null
+++ b/doc/Plugin_Development.md
@@ -0,0 +1,37 @@
+# Plugin Development
+
+Moon Jot is base on a plugin system that make easy to develop your own integration and workflows
+
+# Develop on Moon
+
+Add this with the path to your plugins
+```json
+{
+  "id": 40,
+  "packageName": "PATH_TP_YOUR_PLUGINS/moon-notion-plugin",
+  "description": "Notion app",
+  "fromPath": true, 
+  "devMode": true, 
+  "npmRegistryUrl": "https://npm.pkg.github.com",
+  "npmRegistryConfig": {
+    "auth": {
+      "token": "GITHUB_TOKEN_IF_DEV_PRIVATE"
+    }
+  }
+}
+```
+
+Run `yarn watch` in your plugin root, it will be auto build.
+Open the settings to update the plugin
+Then open the launcher to test it
+You can also check the logs if you use them here
+Use moon.log in `/Users/paolocastro/Library/Application Support/test-paolo-2/moon.log`
+
+## Useful commands
+
+```bash
+npm pub 
+// or 
+npm run build
+npm publish
+```
\ No newline at end of file
diff --git a/src/index.ts b/src/index.ts
index 7858de5..8ee8cdb 100644
--- a/src/index.ts
+++ b/src/index.ts
@@ -48,7 +48,7 @@ export interface PluginManagerCredentials {
   description?: string
   fromPath?: boolean // use installFromPath
   devMode?: boolean // use to auto refresh when developing a plugin
-  status?: 'activated' | 'deactivated' 
+  status?: 'activated' | 'deactivated'
   isMoonPrivate?: boolean
 }