Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Mr-Milk authored Feb 10, 2024
1 parent 32abb76 commit 7993e73
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# Python Hot Module Reload

<p align="center">
<picture align="center">
<img src="https://raw.githubusercontent.com/Mr-Milk/python-hmr/main/assets/logo.svg"
alt="python-hmr logo"height="50"/>
alt="python-hmr logo" height="50"/>
</picture>
</p>
<p align="center">
<i>Better debugging experience with HMR</i>
</p>

# Python Hot Module Reload

![Test status](https://img.shields.io/github/actions/workflow/status/Mr-Milk/python-hmr/test.yaml?label=Test&logo=github&style=flat-square)
![pypi](https://img.shields.io/pypi/v/python-hmr?logoColor=white&style=flat-square)
![license-mit](https://img.shields.io/github/license/Mr-Milk/python-hmr?color=blue&style=flat-square)
Expand All @@ -18,7 +18,7 @@

Automatic reload your project when files are modified.

No need to modify your source code. Works at any environment.
No need to modify your source code. Works in any environment.

![reload](https://github.com/Mr-Milk/python-hmr/blob/main/assets/showcase/reload_demo.gif?raw=true)

Expand All @@ -41,11 +41,11 @@ pip install python-hmr

## Quick Start

> ![Caution]
> From v0.3.0, there is only one API `hmr.reload`.
> [!CAUTION]
> From v0.3.0, there is only one API, `hmr.reload`.
Import your dev packages as usual. And add 2 lines
for automatically reload.
for automatically reloading.

```python
import dev
Expand All @@ -64,7 +64,7 @@ run1, run2 = hmr.reload(run1, run2)
```

Now you are ready to go! Try to modify the `run1` or `run2`
and see the magic happens.
and see the magic happen.


## Detailed Usage
Expand All @@ -85,9 +85,9 @@ a = Runner()
b = Runner()
```

> ![Important]
> Here, when both `a` and `b` will be updated after reloading. This maybe helpful
> if you have a expansive state store within the class instance.
> [!IMPORTANT]
> Here, when both `a` and `b` will be updated after reloading. This may be helpful
> if you have an expansive state store within the class instance.
>
> However, it's suggested to reinitialize the class instance after reloading.
Expand Down Expand Up @@ -141,4 +141,4 @@ run = hmr.reload(run, exclude=["dev.state"])
Inspired from the following package.

- [auto-reloader](https://github.com/moisutsu/auto-reloader)
- [reloadr](https://github.com/hoh/reloadr)
- [reloadr](https://github.com/hoh/reloadr)

0 comments on commit 7993e73

Please sign in to comment.