From 896e266dbd052dd8475d54fc414777da221e7fc3 Mon Sep 17 00:00:00 2001 From: Eduardo Martin Rojo Date: Mon, 11 Jul 2022 16:23:36 +0100 Subject: [PATCH] Changes in readme --- README.md | 29 +++++------------------------ 1 file changed, 5 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 4697679..d2868ca 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 @@ -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.