From 4146c4c9bc2d67eae6a12d17fef6f0b2be29a715 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Hampus=20N=C3=A4sstr=C3=B6m?= Date: Fri, 22 Sep 2023 09:59:56 +0200 Subject: [PATCH] 4 update docs (#9) * Added Info to README.md * Added Shields to README.md * Changed Installation Instructions in README.md --- README.md | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index cc50649..f56d64b 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,26 @@ +![](https://github.com/FAIRmat-NFDI/nomad-material-processing/actions/workflows/publish.yml/badge.svg) +![](https://img.shields.io/pypi/pyversions/nomad-material-processing) +![](https://img.shields.io/pypi/l/nomad-material-processing) +![](https://img.shields.io/pypi/v/nomad-material-processing) + # NOMAD's Material Processing Plugin +This is a plugin for [NOMAD](https://nomad-lab.eu) which contains base sections for +material processing. ## Getting started -This code is currently under development and can be installed by cloning the repository: +`nomad-material-processing` can be installed from PyPI using `pip`: +```sh +pip install nomad-material-processing +``` + +### Development +This code is currently under development and for installing and contributing you should clone the repository: ```sh git clone git@github.com:FAIRmat-NFDI/nomad-material-processing.git cd nomad-material-processing ``` -And installing the package in editable mode: +And install the package in editable mode: ```sh -pip install -e . --index-url https://gitlab.mpcdf.mpg.de/api/v4/projects/2187/packages/pypi/simple +pip install -e . ``` - -**Note!** -Until we have an official pypi NOMAD release with the plugins functionality. Make -sure to include NOMAD's internal package registry (via `--index-url`).