From 3755e83890bd947fe8f0d6534ce26f0f20200bae Mon Sep 17 00:00:00 2001 From: Evgeniy Blinov Date: Mon, 13 Nov 2023 14:13:54 +0300 Subject: [PATCH] readme --- README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fd9a586..1e2d575 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,7 @@ Thanks to this package, it is very easy to manage the lifecycle of packages. ## Table of contents - [**Quick start**](#quick-start) +- [**REPL mode**](#repl-mode) - [**Script launch mode**](#script-launch-mode) - [**Special comment language**](#special-comment-language) - [**Using multiple environments**](#using-multiple-environments) @@ -39,7 +40,7 @@ Install [it](https://pypi.org/project/instld/): pip install instld ``` -And use the library in one of two ways: by running your script through it or by importing a context manager from there. +And use the library in one of three ways: by typing commands via REPL, by running your script through it or by importing a context manager from there. If you run the script [like this](#script-launch-mode), all dependencies will be automatically installed when the application starts and deleted when it stops: @@ -59,6 +60,24 @@ with instld('some_package'): Read more about each method, its capabilities and limitations below. +## REPL mode + +REPL mode is the fastest and easiest way to try out other people's libraries for your code. Just type this in your console: + +```bash +instld +``` + +After that you will see a welcome message similar to this: + +``` +⚡ INSTLD REPL based on +Python 3.11.6 (main, Oct 2 2023, 13:45:54) [Clang 15.0.0 (clang-1500.0.40.1)] on darwin +Type "help", "copyright", "credits" or "license" for more information. + +>>> +``` + ## Script launch mode You can use `instld` to run your script. To do this, you need to run a command like this in the console: