From dfdfed46d3794aa04e17861a4ec9561ec0001931 Mon Sep 17 00:00:00 2001
From: Yngve Levinsen <yngve.levinsen@esss.se>
Date: Tue, 21 Jan 2020 09:52:45 +0100
Subject: [PATCH] updated readme

---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/README.md b/README.md
index ee2f557..3dbe365 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,13 @@ You are free to use this code, but no warranty whatsoever is given.
 
 ### Installation
 
+If you want to install this on the ESS Jupyter server or similar ESS configured computer, then run
+
+```bash
+pip install ess-python-tools -U
+```
+
+If you wish to use our artifactory server then you can add https://artifactory.esss.lu.se/artifactory/api/pypi/pypi-virtual/simple as your index-url or as extra-index-url in your [pip.conf](https://pip.pypa.io/en/stable/user_guide/#id19).
 
 To install/ upgrade the package, run the command below. It is assumed that you have git and pip installed on your system.
 
@@ -19,6 +26,15 @@ If you have installed using Anaconda, we recommend to not use the argument `--us
 
 The argument `-U` implies you should upgrade if you have already installed this package but a newer exist. `--user` implies that this should be installed for the current user only (usually in the folder ~/.local/lib/).
 
+
+### Developers
+
+Development is done directly to the master branch for now, without much in terms of official approval. Try to use your powers wisely (and no worries, sometimes it breaks and we fix it).
+
+Tags are automatically pushed to our internal artifactory server, so users can install pre-compiled binaries using pip. Note that the version set in `ess/__init__.py` should match the tag.
+
+It is recommended that you set up a couple of git hooks to avoid test failures. Set `pre-commit run` as the pre-commit hook, and `python tests.py` as your pre-push hook. If you do not know how to set up hooks, ask Yngve.
+
 ### Usage
 
 Please see the [Online Documentation](http://ess-bp.pages.esss.lu.se/ess-python-tools).
-- 
GitLab