Skip to content

Commit

Permalink
Improve readme file with development guildline
Browse files Browse the repository at this point in the history
  • Loading branch information
ahangarha committed Jan 4, 2024
1 parent d7d87d3 commit 97a51e6
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,22 @@

![logseq-bidi](./images/logseq-bidi-promo-01-hd.jpg)

This plugin adds support for bidirectional text to Logseq graph. By activating
This plugin adds support for bidirectional text to the Logseq graph. By activating
this plugin, regardless of the overall direction of the whole graph, the
content in any block gets rendered in the same direction associated with the
first strong character of that block. This helps to have graphs containing
RTL and LTR content.

## Installation
Install from the marketplace within the Logseq plugins section.

## Development
- Clone this repo
- Run `npm install`
- Run `npm run watch` and apply changes (in `./index.js`)
- Load the plugin in the plugins section using the "Load unpacked plugin" button and open the project's directory
- After every change in development, reload the plugin in the plugin section (or if needed, hard reload Logseq using `Ctrl+R`)
- Before committing changes, use `npm run lint` to check the integrity of the code based on the linter configuration.

## License
This project is released under [AGPL-3.0](https://github.com/dobidi/logseq-bidi/blob/main//LICENSE) license.
This project is released under the [AGPL-3.0](https://github.com/dobidi/logseq-bidi/blob/main/LICENSE) license.

0 comments on commit 97a51e6

Please sign in to comment.