Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pomponchik committed Nov 13, 2023
1 parent 19cd3fb commit 3755e83
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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:

Expand All @@ -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:
Expand Down

0 comments on commit 3755e83

Please sign in to comment.