diff --git a/README.md b/README.md index 8bc9217..8ad9832 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,22 @@ -# mccli +# meshcore-cli -mccli.py : CLI interface to MeschCore companion app over BLE, TCP or Serial +meshcore-cli : CLI interface to MeschCore companion app over BLE, TCP or Serial ## Install -You should install [meshcore](https://github.com/fdlamotte/meshcore_py) package first via pip. +Meshcore-cli depends on the (python meshcore)[https://github.com/fdlamotte/meshcore_py] package. You can install both via `pip` or `pipx` using the command :
-$ pip install meshcore
+$ pipx install meshcore-cli
 
-Then you can put `mccli.py` program in your path. +It will install you `meshcore-cli` and `meshcli`, which is an alias to the former. + ## Usage
-$ mccli.py <args> <commands>
+$ meshcli <args> <commands>
 
### Arguments diff --git a/mccli.py b/src/meshcore_cli/meshcore_cli.py old mode 100755 new mode 100644 similarity index 99% rename from mccli.py rename to src/meshcore_cli/meshcore_cli.py index 1561394..484f6d4 --- a/mccli.py +++ b/src/meshcore_cli/meshcore_cli.py @@ -278,4 +278,5 @@ async def main(argv): while len(cmds) > 0 : cmds = await next_cmd(mc, cmds) -asyncio.run(main(sys.argv[1:])) +def cli(): + asyncio.run(main(sys.argv[1:]))