diff --git a/README.md b/README.md index 186db88..98e862b 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,15 @@ +# Python Hot Module Reload +

python-hmr logo + alt="python-hmr logo" height="50"/>

Better debugging experience with HMR

-# 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) @@ -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) @@ -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 @@ -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 @@ -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. @@ -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) \ No newline at end of file +- [reloadr](https://github.com/hoh/reloadr)