diff --git a/README.md b/README.md index dbf4ab0..6741f7d 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,23 @@ # md2bbc -Markdown to PC's BBcode. Quick n' dirty one. \ No newline at end of file +Markdown to PC's BBcode. Quick'n'dirty one. + +## Usage + +``` +python3 md2bbc.py input.md > output.bbcode +``` + +## Features + +- `# H1 title` +- `## H2 title` +- `### H3 title` +- `*emphasis text*` +- `**strong text**` +- `[link](https://domain.tld)` +- `{{ tableofcontents }}` + +More features may be added in the future, but this script is provided as it. +Only (very) simple markup will produce correct output. +Always check BBcode validity before posting.