Skip to content

Commit 24381bf

Browse files
committed
Update examples with new imports and fix names.
1 parent 02f8eaa commit 24381bf

File tree

4 files changed

+10
-10
lines changed

4 files changed

+10
-10
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
<h3 align="center">tkintermd</h3>
3434

3535
<p align="center">
36-
An embeddable tkinter based Markdown editor with HTML preview.
36+
A Markdown editor with HTML preview for use in tkinter projects.
3737
<br />
3838
<a href="https://hreikin.github.io/tkintermd"><strong>Explore the docs »</strong></a>
3939
<br />
@@ -93,7 +93,7 @@
9393

9494
<!-- [![Product Name Screen Shot][product-screenshot]](https://example.com) -->
9595

96-
An embeddable `tkinter` based Markdown editor with HTML preview. The editor has
96+
A Markdown editor with HTML preview for use in tkinter projects. The editor has
9797
syntax highlighting provided by `Pygments` and the HTML preview window is
9898
provided by `tkinterweb`.
9999

@@ -156,16 +156,16 @@ Alternatively you can install from source by following the steps below:
156156

157157
#### Embedded
158158

159-
To use the `TkinterMDFrame` in one of your own python scripts:
159+
To use the `TkintermdFrame` in one of your own python scripts:
160160

161161
```python
162-
from tkintermd.tkintermd_frame import TkinterMDFrame
162+
from tkintermd.tkintermd_frame import TkintermdFrame
163163

164164
import tkinter as tk
165165
from tkinter.constants import *
166166

167167
root = tk.Tk()
168-
app = TkinterMDFrame(root)
168+
app = TkintermdFrame(root)
169169
app.pack(fill="both", expand=1)
170170
app.mainloop()
171171
```

docs/getting-started/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,16 +45,16 @@ Alternatively you can install from source by following the steps below:
4545

4646
### Embedded
4747

48-
To use the `TkinterMDFrame` in one of your own python scripts:
48+
To use the `TkintermdFrame` in one of your own python scripts:
4949

5050
```python
51-
from tkintermd.tkintermd_frame import TkinterMDFrame
51+
from tkintermd.frame import TkintermdFrame
5252

5353
import tkinter as tk
5454
from tkinter.constants import *
5555

5656
root = tk.Tk()
57-
app = TkinterMDFrame(root)
57+
app = TkintermdFrame(root)
5858
app.pack(fill="both", expand=1)
5959
app.mainloop()
6060
```

docs/reference/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@ authors:
77
## `tkintermd`
88

99
- [Constants](./tkintermd-constants.md)
10-
- [TkinterMDFrame](./tkintermd-frame.md)
10+
- [TkintermdFrame](./tkintermd-frame.md)
1111
- [Lexer](tkintermd-lexer.md)

docs/reference/tkintermd-frame.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: TkinterMDFrame
2+
title: TkintermdFrame
33
summary: API reference for the TkinterMDFrame.
44
authors:
55
- hreikin

0 commit comments

Comments
 (0)