Skip to content

Commit 644841e

Browse files
committed
docs: update readme.md
1 parent a7ccbda commit 644841e

File tree

1 file changed

+8
-13
lines changed

1 file changed

+8
-13
lines changed

readme.md

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,13 @@
1-
# Logseq Plugin Template React 🚀
1+
# Logseq TickTick Plugin
2+
3+
This is a plugin for [Logseq](https://logseq.com/) that allows you to create tasks in [TickTick](https://ticktick.com/) without leaving Logseq.
24

35
## Features
46

5-
- Plug-and-play boilerplate with properly defined GitHub action defaults
6-
- Develop with HMR, empowered by lightning-fast Vite ⚡ with [vite-logseq-plugin](https://github.com/pengx17/vite-plugin-logseq)
7-
- TailwindCSS for styling
8-
- Pnpm
7+
- Create tasks in TickTick with `/tt`-command
8+
- Create tasks with priority and tags
9+
- Create subtasks
910

1011
## How to get started
11-
1. Clone the repository or use the button "Use this template" on GitHub to create your own version of the repository 🔨
12-
2. Make sure you have pnpm installed, [install](https://pnpm.io/installation) if necessary 🛠
13-
3. Execute `pnpm install` 📦
14-
4. Change the plugin-name in `package.json` to your liking. Adapt both the package-name and the plugin-id at the bottom of the `package.json`. Make sure that they are not conflicting with plugins you already installed. 📝
15-
5. Execute `pnpm build` to build the plugin 🚧
16-
6. Enable developer-mode in Logseq, go to plugins, select "Load unpacked plugin" 🔌
17-
7. Select the directory of your plugin (not the `/dist`-directory, but the directory which includes your package.json) 📂
18-
8. Enjoy! 🎉
12+
13+
TODO

0 commit comments

Comments
 (0)