Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Installation Instructions to README.md #22

Merged
merged 3 commits into from
Nov 5, 2022
Merged

Add Installation Instructions to README.md #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a87503d
add install instructions
mikemhenry Nov 5, 2022
6113c15
fix link in docs
mikemhenry Nov 5, 2022
66644ac
better guide in readme
mikemhenry Nov 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,22 @@ You can see the [⭐️ Documentation ⭐️](https://vsoch.github.io/action-upd

## ⭐️ Quick Start ⭐️

### Installation

The module is available in pypi as [action-updater](https://pypi.org/project/action-updater/),
and to install we first recommend some kind of virtual environment:

```bash
$ python -m venv env
$ source env/bin/activate
```

And then install from pypi using pip:

```bash
$ pip install action-updater
```

### Usage

For all commands below, the actions updater can accept a directory with yaml files,
Expand Down
2 changes: 1 addition & 1 deletion docs/getting_started/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The Action Updater can be installed from pypi, or from source.
Pypi
====

The module is available in pypi as `action-updater <https://pypi.org/project/singularity-hpc/>`_,
The module is available in pypi as `action-updater <https://pypi.org/project/action-updater/>`_,
and to install we first recommend some kind of virtual environment:

.. code-block:: console
Expand Down