Skip to content

Commit aa00e58

Browse files
committed
chore: readme.md tweak
1 parent 0b1180a commit aa00e58

1 file changed

Lines changed: 15 additions & 1 deletion

File tree

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,28 @@ If the markdown includes relative images or other assets, you can use the --doma
2727
md2bbcode README.md --domain https://raw.githubusercontent.com/RedGuides/md2bbcode/main/
2828
```
2929

30+
You can also use the package in your Python project:
31+
32+
```python
33+
from md2bbcode.main import process_readme
34+
35+
# Your Markdown content
36+
markdown_text = "# Hell World"
37+
38+
# Convert Markdown to BBCode
39+
bbcode_output = process_readme(markdown_text)
40+
41+
# Output the BBCode
42+
print(bbcode_output)
43+
```
44+
3045
### Debug Mode
3146

3247
You can use the `--debug` flag to save intermediate results to files for debugging:
3348

3449
```bash
3550
md2bbcode README.md --debug
3651
```
37-
3852
## Development
3953

4054
If you want to contribute to md2bbcode or set up a development environment, follow these steps:

0 commit comments

Comments
 (0)