Skip to content

Commit

Permalink
📝 Add documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
castroCrea committed Apr 20, 2024
1 parent 57cd00b commit 60f6303
Show file tree
Hide file tree
Showing 3 changed files with 59 additions and 34 deletions.
54 changes: 21 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
@@ -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`
# 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)
37 changes: 37 additions & 0 deletions doc/Plugin_Development.md
Original file line number Diff line number Diff line change
@@ -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
```
2 changes: 1 addition & 1 deletion src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
}

Expand Down

0 comments on commit 60f6303

Please sign in to comment.