Skip to content

Commit

Permalink
README, haxelib.json: expand description
Browse files Browse the repository at this point in the history
  • Loading branch information
joshtynjala committed Mar 13, 2024
1 parent 6209b74 commit 8c11d46
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Markdown for OpenFL

Extends the Haxe [Markdown](https://lib.haxe.org/p/markdown) library to add support for the OpenFL `TextField` class.
Extends the Haxe [Markdown](https://lib.haxe.org/p/markdown) library to support the `htmlText` property of OpenFL's `TextField` class. A very limited subset of HTML is supported by `TextField`, so the normal HTML generated by Markdown needs to be simplified.

## Install

Expand All @@ -20,7 +20,7 @@ Then, add the following line to your OpenFL [_project.xml_](https://lime.softwar

The following example displays Markdown in an `openfl.text.TextField` using its `htmlText` property.

```hx
```haxe
var rawMarkdown = "Hello, **world**!";
var htmlText = TextFieldMarkdown.markdownToHtml(rawText);
Expand Down
2 changes: 1 addition & 1 deletion haxelib.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"url": "https://github.com/BowlerHatLLC/haxe-markdown-openfl-textfield",
"license": "MIT",
"tags": ["markdown", "openfl", "textfield"],
"description": "A markdown library for OpenFL",
"description": "Display markdown using the htmlText property of OpenFL's TextField class",
"version": "1.0.2",
"releasenote": "Fix exception for nodes without children.",
"contributors": ["bowlerhat"],
Expand Down

0 comments on commit 8c11d46

Please sign in to comment.