diff --git a/README.md b/README.md index 6d3f665..f9f05ac 100644 --- a/README.md +++ b/README.md @@ -1 +1,61 @@ -WIP \ No newline at end of file + + +# logseq-auto-rtl-plugin + +![GitHub Workflow Status](https://img.shields.io/github/workflow/status/abc3354/logseq-auto-rtl-plugin/Build%20plugin) +![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability-percentage/abc3354/logseq-auto-rtl-plugin) +![Depfu](https://img.shields.io/depfu/abc3354/logseq-auto-rtl-plugin) +![Standard readme compliant](https://img.shields.io/badge/standard--readme-OK-brightgreen) + +A [Logseq](https://github.com/logseq/logseq) plugin to help writing right-to-left text + +This plugin will transform the bloc into a RTL bloc if RTL characters are detected at the start of the content. + +![A gif showing how the plugin works](screenshots/usage.gif) + +For now the plugins works by adding invisible blocs in the markdown. This should be fine if you don't want to +export the markdown. I am searching for a better solution. + +## Table of Contents + +- [Install](#install) +- [Maintainers](#maintainers) +- [Contributing](#contributing) +- [Sponsors](#sponsors) +- [License](#license) + +## Install + +For now, use the latest github release. + +## Maintainers + +[@abc3354](https://github.com/abc3354) + +## Contributing + +PRs gladly accepted ! + +### How to install the dev version + +- build the plugin + ```shell + $ nmp i + $ npm run build + ``` +- Use Logseq's `Load unpacked plugin` to and select the directory + + +Small note: If editing the README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification. + +## Sponsors + +Huge thanks to [Motleq]() for sponsoring the development of this plugin <3 + +If this plugin helped you, you can buy me a coffee using the button below :) + +[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/gbraad) + +## License + +MIT © 2022 abc3354 diff --git a/icon.svg b/icon.svg new file mode 100644 index 0000000..fd1a846 --- /dev/null +++ b/icon.svg @@ -0,0 +1,9 @@ + + icon + + + Layer 1 + + + + \ No newline at end of file diff --git a/package.json b/package.json index 3c54e18..eac0032 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,14 @@ "logseq": { "id": "logseq-auto-rtl-plugin", "title": "logseq-auto-rtl-plugin", - "icon": "./icon.svg" + "description": "A plugin to support right-to-left editing", + "author": "abc3354", + "repo": "https://github.com/abc3354/logseq-auto-rtl-plugin", + "icon": "./icon.svg", + "theme": false, + "sponsors": [ + "Motlaq" + ] }, "name": "logseq-auto-rtl-plugin", "version": "0.1", @@ -16,7 +23,7 @@ "build": "parcel build src/index.html --public-url ./" }, "keywords": [], - "author": "Motlaq, abc3354", + "author": "abc3354", "license": "MIT", "dependencies": { "@logseq/libs": "^0.0.1-alpha.34" diff --git a/screenshots/usage.gif b/screenshots/usage.gif new file mode 100644 index 0000000..0d03a7d Binary files /dev/null and b/screenshots/usage.gif differ