Skip to content
This repository has been archived by the owner on Jun 21, 2019. It is now read-only.

Commit

Permalink
Updated documentation for latest changes
Browse files Browse the repository at this point in the history
  • Loading branch information
wooorm committed Jul 12, 2014
1 parent 8ecb7c1 commit 0e8717d
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ console.log(root.toString(), root.data.direction);
This example also uses [retext-visit](https://github.com/wooorm/retext-visit).

## API
None, the plugin automatically detects the direction (either `"ltr"`, `"rtl"`, or `"neutral"`) of each word when its created or changed, stores that direction in `data.direction` on the word. If every WordNode inside a parent has the same direction, the parent has the same direction, otherwise, the parent has a neutral direction.
None, the plugin automatically detects the direction (either `"ltr"`, `"rtl"`, or `"neutral"`) of each text node when its created, changed, or removed, and stores that direction in `data.direction` on the node. If every text node inside a parent has the same direction, the parent has the same direction, otherwise, the parent has a neutral direction.

## Browser Support
Pretty much every browser (available through browserstack) runs all retext-directionality unit tests.
Expand Down

0 comments on commit 0e8717d

Please sign in to comment.