Skip to content

Commit

Permalink
Changes in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
emrojo committed Jul 11, 2022
1 parent 329b9c9 commit 896e266
Showing 1 changed file with 5 additions and 24 deletions.
29 changes: 5 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# tol-lab-share

Rabbitmq consumer for TOL data input
# lab-share-lib

Library to build consumers for the lab-share framework

## Getting Started

Expand All @@ -23,24 +22,12 @@ Use pipenv to install the required python packages for the application and devel
pipenv install --dev
```

## Configuring

### Setting up with Docker

If you want to setup a local development environment with Docker please check
the instructions in [SETUP_DOCKER.md](SETUP_DOCKER.md)


## Running

1. Enter the python virtual environment using:
```bash
pipenv shell
```

1. Run the app using:
Run this command inside the project you want to add this library:

```bash
python tol-lab-share
pipenv install lab-share-lib
```

## Testing
Expand All @@ -50,9 +37,3 @@ Run the tests using pytest (flags are for verbose and exit early):
```bash
python -m pytest -vx
```

## Deployment

This project uses a Docker image as the unit of deployment. Update `.release-version` with
major/minor/patch. On merging a pull request into *develop* or *master*, a release will be created
along with the Docker image associated to that release.

0 comments on commit 896e266

Please sign in to comment.